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

Author:

Apache Directory Project

Optional Element Summary

boolean	allowAnonymousAccess Tells if anonymous access are allowed or not.
String	certificatePassword The certificate password in base64, default to the empty string
Class<?>[]	extendedOpHandlers name of the classes implementing extended operations
Class<?>	factory The LdapServer factory
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.
String	name The instance name
Class<?>	ntlmProvider NTLM provider class, default value is a invalid class
String	saslHost The name of this host, validated during SASL negotiation.
SaslMechanism[]	saslMechanisms supported set of SASL mechanisms
String	saslPrincipal The service principal, used by GSSAPI.
CreateTransport[]	transports The transports to use, default to LDAP

name

public abstract String name

The instance name

Default:

"DefaultLdapServer"

transports

public abstract CreateTransport[] transports

The transports to use, default to LDAP

Default:

{}

factory

public abstract 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 String keyStore

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

Default:

""

certificatePassword

public abstract String certificatePassword

The certificate password in base64, default to the empty string

Default:

""

extendedOpHandlers

public abstract Class<?>[] extendedOpHandlers

name of the classes implementing extended operations

Default:

{}

saslMechanisms

public abstract SaslMechanism[] saslMechanisms

supported set of SASL mechanisms

Default:

{}

ntlmProvider

public abstract Class<?> ntlmProvider

NTLM provider class, default value is a invalid class

Default:

java.lang.Object.class

saslHost

public abstract String saslHost

The name of this host, validated during SASL negotiation.

Default:

"ldap.example.com"

saslPrincipal

public abstract String saslPrincipal

The service principal, used by GSSAPI.

Default:

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