com.btmatthews.maven.plugins.ldap.mojos.LDIFDumperMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ldap-maven-plugin Show documentation

Parse and load LDIF records to an LDAP directory server. Dump records from an LDAP directory server to LDIF or DSML formats.

The newest version!

/*
 * Copyright 2008 Brian Thomas Matthews
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.btmatthews.maven.plugins.ldap.mojos;

import java.io.PrintWriter;

import netscape.ldap.util.LDAPWriter;
import netscape.ldap.util.LDIFWriter;

/**
 * This Mojo implements the dsml-dump goal which dumps content from the LDAP
 * directory server in LDIF format.
 * 
 * @author Brian Matthews
 * @version 1.0
 * @goal ldif-dump
 */
public final class LDIFDumperMojo
    extends AbstractLDAPDumperMojo
{
    /**
     * The default constructor.
     */
    public LDIFDumperMojo()
    {
    }

    /**
     * Create the LDAP writer that will dump LDAP entries in LDIF format.
     * 
     * @param writer
     *            The writer for the target output stream.
     * @return The LDAP writer.
     */
    protected LDAPWriter openLDAPWriter(final PrintWriter writer)
    {
        return new LDIFWriter(writer);
    }

    /**
     * Close the LDAP wrtier that was returned by openLDAPWriter.
     * 
     * @param writer
     *            The writer for the target output stream.
     * @param ldapWriter
     *            The LDAP writer.
     */
    protected void closeLDAPWriter(final PrintWriter writer,
        final LDAPWriter ldapWriter)
    {
    }
}