org.apache.jackrabbit.oak.security.authentication.ldap.impl

Class LdapProviderConfig.PoolConfig

java.lang.Object

org.apache.jackrabbit.oak.security.authentication.ldap.impl.LdapProviderConfig.PoolConfig

Enclosing class:

LdapProviderConfig

public static class LdapProviderConfig.PoolConfig
extends Object

Defines the configuration of a connection pool. Currently we only define the max size. (documentation copied from GenericObjectPool)

Constructor Summary

Constructors

Constructor and Description
PoolConfig()

Method Summary

Modifier and Type	Method and Description
int	getMaxActive() Returns the maximum number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time.
boolean	lookupOnValidate() Defines if the lookup on validate flag is enabled.
LdapProviderConfig.PoolConfig	setLookupOnValidate(boolean lookupOnValidate) Sets the lookup on validate flag.
LdapProviderConfig.PoolConfig	setMaxActive(int maxActive) Sets the cap on the number of objects that can be allocated by the pool.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PoolConfig

public PoolConfig()

Method Detail

getMaxActive

public int getMaxActive()

Returns the maximum number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. When non-positive, there is no limit to the number of objects that can be managed by the pool at one time. A value of 0 disables this pool.

Returns:

the cap on the total number of object instances managed by the pool.

See Also:

setMaxActive(int)

setMaxActive

@Nonnull
public LdapProviderConfig.PoolConfig setMaxActive(int maxActive)

Sets the cap on the number of objects that can be allocated by the pool.

Parameters:

maxActive - the new upper limit of the pool size

Returns:

this

See Also:

getMaxActive()

lookupOnValidate

public boolean lookupOnValidate()

Defines if the lookup on validate flag is enabled. If enable a connection that taken from the pool are validated before used. currently this is done by performing a lookup to the ROOT DSE, which might not be allowed on all LDAP servers.

Returns:

true if the flag is enabled.

setLookupOnValidate

@Nonnull
public LdapProviderConfig.PoolConfig setLookupOnValidate(boolean lookupOnValidate)

Sets the lookup on validate flag.

Parameters:

lookupOnValidate - the new value of the lookup on validate flag

Returns:

this

See Also:

lookupOnValidate()

toString

public String toString()

Overrides:

toString in class Object