org.apache.directory.server.annotations

Annotation Type CreateLdapServer

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
public @interface CreateLdapServer

A annotation used to define a LdapServer configuration. Many elements can be configured :

• The server ID (or name)
• The max time limit
• the max size limit
• Should it allow anonymous access
• The keyStore file
• The certificate password

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowAnonymousAccess Tells if anonymous access are allowed or not.
java.lang.String	certificatePassword The certificate password in base64, default to the empty string
java.lang.Class<?>[]	extendedOpHandlers name of the classes implementing extended operations
java.lang.Class<?>	factory The LdapServer factory
java.lang.String	keyStore The external keyStore file to use, default to the empty string
long	maxSizeLimit The maximum size limit.
int	maxTimeLimit The maximum time limit.
java.lang.String	name The instance name
java.lang.Class<?>	ntlmProvider NTLM provider class, default value is a invalid class
java.lang.String	saslHost The name of this host, validated during SASL negotiation.
SaslMechanism[]	saslMechanisms supported set of SASL mechanisms
java.lang.String	saslPrincipal The service principal, used by GSSAPI.
java.lang.String[]	saslRealms The name of this host, validated during SASL negotiation.
CreateTransport[]	transports The transports to use, default to LDAP

Element Detail

name

public abstract java.lang.String name

The instance name

Default:

"DefaultLdapServer"

transports

public abstract CreateTransport[] transports

The transports to use, default to LDAP

Default:

{}

factory

public abstract java.lang.Class<?> factory

The LdapServer factory

Default:

org.apache.directory.server.factory.DefaultLdapServerFactory.class

maxSizeLimit

public abstract long maxSizeLimit

The maximum size limit.

Default:

1000L

maxTimeLimit

public abstract int maxTimeLimit

The maximum time limit.

Default:

1000

allowAnonymousAccess

public abstract boolean allowAnonymousAccess

Tells if anonymous access are allowed or not.

Default:

false

keyStore

public abstract java.lang.String keyStore

The external keyStore file to use, default to the empty string

Default:

""

certificatePassword

public abstract java.lang.String certificatePassword

The certificate password in base64, default to the empty string

Default:

""

extendedOpHandlers

public abstract java.lang.Class<?>[] extendedOpHandlers

name of the classes implementing extended operations

Default:

{}

saslMechanisms

public abstract SaslMechanism[] saslMechanisms

supported set of SASL mechanisms

Default:

{}

ntlmProvider

public abstract java.lang.Class<?> ntlmProvider

NTLM provider class, default value is a invalid class

Default:

java.lang.Object.class

saslHost

public abstract java.lang.String saslHost

The name of this host, validated during SASL negotiation.

Default:

"ldap.example.com"

saslRealms

public abstract java.lang.String[] saslRealms

The name of this host, validated during SASL negotiation.

Default:

"example.com"

saslPrincipal

public abstract java.lang.String saslPrincipal

The service principal, used by GSSAPI.

Default:

"ldap/ldap.example.com@EXAMPLE.COM"