ldap:dump

Full name:

com.btmatthews.maven.plugins:ldap-maven-plugin:1.3.2:dump

Description:

This is the abstract base class for all Mojos in the ldap-maven-plugin plugin that dump content from the directory server. Concrete classes must implement the getLDAPWriter() method to return the writer that will format the output appropriately.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.2.0.

Required Parameters

Name Type Since Description
authDn String 1.2.0 The distinguished name used if authentication is required.
filename String 1.2.0 The output file name.
outputDirectory File 1.2.0 The target output directory.
Default value is: ${project.build.directory}.
passwd String 1.2.0 The password used if authentication is required.
searchBase String 1.2.0 The search base.
searchFilter String 1.2.0 The search filter.
Default value is: (objectclass=*).

Optional Parameters

Name Type Since Description
connectionRetries int 1.2.0 The maximum number of connection attempts before failing.
Default value is: 3.
connectionTimeout int 1.2.0 The connection timeout.
Default value is: 5000.
format String 1.2.0 The output file format.
  • ldif
  • dsml

Default value is: ldif.
host String 1.2.0 The host name of the LDAP directory server. Defaults to localhost.
Default value is: localhost.
port int 1.2.0 The port number of the LDAP directory server. Defaults to 389.
Default value is: 389.
skip boolean 1.2.0 To skip execution of the plugin
Default value is: false.

Parameter Details

authDn:

The distinguished name used if authentication is required.
  • Type: java.lang.String
  • Since: 1.2.0
  • Required: Yes

connectionRetries:

The maximum number of connection attempts before failing.
  • Type: int
  • Since: 1.2.0
  • Required: No
  • Default: 3

connectionTimeout:

The connection timeout.
  • Type: int
  • Since: 1.2.0
  • Required: No
  • Default: 5000

filename:

The output file name.
  • Type: java.lang.String
  • Since: 1.2.0
  • Required: Yes

format:

The output file format.
  • ldif
  • dsml
  • Type: java.lang.String
  • Since: 1.2.0
  • Required: No
  • Default: ldif

host:

The host name of the LDAP directory server. Defaults to localhost.
  • Type: java.lang.String
  • Since: 1.2.0
  • Required: No
  • Default: localhost

outputDirectory:

The target output directory.
  • Type: java.io.File
  • Since: 1.2.0
  • Required: Yes
  • Default: ${project.build.directory}

passwd:

The password used if authentication is required.
  • Type: java.lang.String
  • Since: 1.2.0
  • Required: Yes

port:

The port number of the LDAP directory server. Defaults to 389.
  • Type: int
  • Since: 1.2.0
  • Required: No
  • Default: 389

searchBase:

The search base.
  • Type: java.lang.String
  • Since: 1.2.0
  • Required: Yes

searchFilter:

The search filter.
  • Type: java.lang.String
  • Since: 1.2.0
  • Required: Yes
  • Default: (objectclass=*)

skip:

To skip execution of the plugin
  • Type: boolean
  • Since: 1.2.0
  • Required: No
  • Default: false