ldap:run

Full name:

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

Description:

This Mojo implements the run goal which launches an embedded LDAP directory server.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.1.0.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
monitorKey String 1.1.0 Key to provide when sending commands to the mail apache.
User property is: monitor.key.
monitorPort int 1.1.0 The port to listen on for the monitor commands.
User property is: monitor.port.
outputDirectory File 1.1.0 The build target directory.
Default value is: ${project.build.directory}.
rootDn String 1.1.0 The root DN for the LDAP server.
User property is: ldap.root.

Optional Parameters

Name Type Since Description
authDn String 1.1.0 The identity of the admin account for tbe directory server.
Default value is: uid=admin,ou=system.
User property is: ldap.authDn.
daemon boolean 1.1.0 If true the server is run as a daemon.
Default value is: false.
User property is: monitor.daemon.
ldapPort int 1.1.0 The port for the LDAP server.
Default value is: 389.
User property is: ldap.port.
ldifFile File 1.1.0 An optional LDIF file that can be used to seed the embedded LDAP server.
User property is: ldap.ldif.
monitorRetryCount int 2.1.1 The number of times to retry when checking if the server has started or stopped.
Default value is: 3.
User property is: monitor.retryCount.
monitorRetryInterval int 2.1.1 The delay in milliseconds before retrying the check to see if the server has started or stopped.
Default value is: 500.
User property is: monitor.retryInterval.
objectClasses String 1.1.0 (no description)
User property is: ldap.objectClasses.
passwd String 1.1.0 The credentials for the admin account of the directory server.
Default value is: secret.
User property is: ldap.passwd.
serverType String 1.1.0 The server can be one of:
  • apacheds
  • - Use ApacheDS 1.5.5
  • opendj
  • - Use OpenDJ 2.6.0
  • unboundid
  • - Use UnboundID 3.1.0
  • dependency-[serverType]
  • - Use custom server included as plugin dependency and identified by serverType
  • dependency-[serverType]-[groupId]:[artifactId]:[version]
  • - Use custom server specified by the GAV coordinates and identified by serverType

Default value is: unboundid.
User property is: ldap.type.

Parameter Details

authDn:

The identity of the admin account for tbe directory server.
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No
  • User Property: ldap.authDn
  • Default: uid=admin,ou=system

daemon:

If true the server is run as a daemon.
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: monitor.daemon
  • Default: false

ldapPort:

The port for the LDAP server.
  • Type: int
  • Since: 1.1.0
  • Required: No
  • User Property: ldap.port
  • Default: 389

ldifFile:

An optional LDIF file that can be used to seed the embedded LDAP server.
  • Type: java.io.File
  • Since: 1.1.0
  • Required: No
  • User Property: ldap.ldif

monitorKey:

Key to provide when sending commands to the mail apache.
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: Yes
  • User Property: monitor.key

monitorPort:

The port to listen on for the monitor commands.
  • Type: int
  • Since: 1.1.0
  • Required: Yes
  • User Property: monitor.port

monitorRetryCount:

The number of times to retry when checking if the server has started or stopped.
  • Type: int
  • Since: 2.1.1
  • Required: No
  • User Property: monitor.retryCount
  • Default: 3

monitorRetryInterval:

The delay in milliseconds before retrying the check to see if the server has started or stopped.
  • Type: int
  • Since: 2.1.1
  • Required: No
  • User Property: monitor.retryInterval
  • Default: 500

objectClasses:

(no description)
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No
  • User Property: ldap.objectClasses

outputDirectory:

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

passwd:

The credentials for the admin account of the directory server.
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No
  • User Property: ldap.passwd
  • Default: secret

rootDn:

The root DN for the LDAP server.
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: Yes
  • User Property: ldap.root

serverType:

The server can be one of:
  • apacheds
  • - Use ApacheDS 1.5.5
  • opendj
  • - Use OpenDJ 2.6.0
  • unboundid
  • - Use UnboundID 3.1.0
  • dependency-[serverType]
  • - Use custom server included as plugin dependency and identified by serverType
  • dependency-[serverType]-[groupId]:[artifactId]:[version]
  • - Use custom server specified by the GAV coordinates and identified by serverType
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No
  • User Property: ldap.type
  • Default: unboundid