org.apache.directory.server.annotations

Annotation Type CreateLdapConnectionPool

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

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

• The connection timeout
• A list of attributes to be interpreted as binary (in addition to the defaults)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	additionalBinaryAttributes Attributes names to be added to the list of default binary attributes
java.lang.Class<? extends org.apache.directory.ldap.client.api.LdapConnectionFactory>	connectionFactoryClass LdapConnection factory implementation class
java.lang.Class<? extends org.apache.commons.pool.PoolableObjectFactory<org.apache.directory.ldap.client.api.LdapConnection>>	factoryClass LdapConnection pool factory implementation class
boolean	lifo Connections borrowed in LIFO order, default true
int	maxActive The maximum number of active connections, default 8
int	maxIdle The maximum number of idle connections, default 8
long	maxWait The maximum amount of time to wait for a connection to be returned in millis, default -1
long	minEvictableIdleTimeMillis The minimum idle time before evicting a connection in millis, default 1000*60*30
int	minIdle The minumum number of idle instances before evictor spawns new object, default 0
int	numTestsPerEvictionRun The number of objects to test per eviction run, default 3
long	softMinEvictableIdleTimeMillis Same as minEvictableIdleTimeMillis with extra condition that minIdle objects remain in pool, default -1
boolean	testOnBorrow If true, connection will be tested on borrow, default false
boolean	testOnReturn If true, connection will be tested on return, default false
boolean	testWhileIdle If true, connection will be tested on while idle, default false
long	timeBetweenEvictionRunsMillis The time, in millis, between eviction runs, default -1 (forever)
long	timeout The connection timeout in millis, default 30000
java.lang.Class<? extends org.apache.directory.ldap.client.api.LdapConnectionValidator>	validatorClass The class to use for validation
byte	whenExhaustedAction The default action when connections are exhausted, default 1 (block)

Element Detail

additionalBinaryAttributes

public abstract java.lang.String[] additionalBinaryAttributes

Attributes names to be added to the list of default binary attributes

Default:

{}

connectionFactoryClass

public abstract java.lang.Class<? extends org.apache.directory.ldap.client.api.LdapConnectionFactory> connectionFactoryClass

LdapConnection factory implementation class

Default:

org.apache.directory.ldap.client.api.DefaultLdapConnectionFactory.class

factoryClass

public abstract java.lang.Class<? extends org.apache.commons.pool.PoolableObjectFactory<org.apache.directory.ldap.client.api.LdapConnection>> factoryClass

LdapConnection pool factory implementation class

Default:

org.apache.directory.ldap.client.api.DefaultPoolableLdapConnectionFactory.class

lifo

public abstract boolean lifo

Connections borrowed in LIFO order, default true

Default:

true

maxActive

public abstract int maxActive

The maximum number of active connections, default 8

Default:

8

maxIdle

public abstract int maxIdle

The maximum number of idle connections, default 8

Default:

8

maxWait

public abstract long maxWait

The maximum amount of time to wait for a connection to be returned in millis, default -1

Default:

-1L

minEvictableIdleTimeMillis

public abstract long minEvictableIdleTimeMillis

The minimum idle time before evicting a connection in millis, default 1000*60*30

Default:

1800000L

minIdle

public abstract int minIdle

The minumum number of idle instances before evictor spawns new object, default 0

Default:

0

numTestsPerEvictionRun

public abstract int numTestsPerEvictionRun

The number of objects to test per eviction run, default 3

Default:

3

softMinEvictableIdleTimeMillis

public abstract long softMinEvictableIdleTimeMillis

Same as minEvictableIdleTimeMillis with extra condition that minIdle objects remain in pool, default -1

Default:

-1L

testOnBorrow

public abstract boolean testOnBorrow

If true, connection will be tested on borrow, default false

Default:

false

testOnReturn

public abstract boolean testOnReturn

If true, connection will be tested on return, default false

Default:

false

testWhileIdle

public abstract boolean testWhileIdle

If true, connection will be tested on while idle, default false

Default:

false

timeBetweenEvictionRunsMillis

public abstract long timeBetweenEvictionRunsMillis

The time, in millis, between eviction runs, default -1 (forever)

Default:

-1L

timeout

public abstract long timeout

The connection timeout in millis, default 30000

Default:

30000L

validatorClass

public abstract java.lang.Class<? extends org.apache.directory.ldap.client.api.LdapConnectionValidator> validatorClass

The class to use for validation

Default:

org.apache.directory.ldap.client.api.DefaultLdapConnectionValidator.class

whenExhaustedAction

public abstract byte whenExhaustedAction

The default action when connections are exhausted, default 1 (block)

Default:

1