org.apache.directory.ldap.client.api

Class AbstractPoolableLdapConnectionFactory

java.lang.Object

org.apache.directory.ldap.client.api.AbstractPoolableLdapConnectionFactory

All Implemented Interfaces:

org.apache.commons.pool.PoolableObjectFactory<LdapConnection>

Direct Known Subclasses:

DefaultPoolableLdapConnectionFactory, ValidatingPoolableLdapConnectionFactory

public abstract class AbstractPoolableLdapConnectionFactory
extends Object
implements org.apache.commons.pool.PoolableObjectFactory<LdapConnection>

An abstract class implementing the PoolableObjectFactory, for LdapConnections.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected LdapConnectionFactory	connectionFactory The factory to use to create a new connection
private static org.slf4j.Logger	LOG This class logger
protected LdapConnectionValidator	validator The validator to use

Constructor Summary

Constructors

Constructor and Description
AbstractPoolableLdapConnectionFactory()

Method Summary

Modifier and Type	Method and Description
void	activateObject(LdapConnection connection) There is nothing to do to activate a connection.
void	destroyObject(LdapConnection connection) Destroying a connection will unbind it which will result on a shutdown of teh underlying protocol.
org.apache.directory.api.ldap.codec.api.LdapApiService	getLdapApiService() Returns the LdapApiService instance used by this factory.
LdapConnection	makeObject() Specifically, we are creating a new connection based on the LdapConnection Factory we used to create this pool of connections.
protected static LdapConnectionFactory	newLdapConnectionFactory(LdapConnectionConfig config, Class<? extends LdapConnectionFactory> connectionFactoryClass)
void	passivateObject(LdapConnection connection) We don't do anything with the connection.
void	setValidator(LdapConnectionValidator validator) Sets the validator to use when validation occurs.
boolean	validateObject(LdapConnection connection) Validating a connection is done by checking the connection status.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

This class logger

connectionFactory

protected LdapConnectionFactory connectionFactory

The factory to use to create a new connection

validator

protected LdapConnectionValidator validator

The validator to use

Constructor Detail

AbstractPoolableLdapConnectionFactory

public AbstractPoolableLdapConnectionFactory()

Method Detail

activateObject

public void activateObject(LdapConnection connection)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

There is nothing to do to activate a connection.

Specified by:

activateObject in interface org.apache.commons.pool.PoolableObjectFactory<LdapConnection>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

destroyObject

public void destroyObject(LdapConnection connection)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Destroying a connection will unbind it which will result on a shutdown of teh underlying protocol.

Specified by:

destroyObject in interface org.apache.commons.pool.PoolableObjectFactory<LdapConnection>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getLdapApiService

public org.apache.directory.api.ldap.codec.api.LdapApiService getLdapApiService()

Returns the LdapApiService instance used by this factory.

Returns:

The LdapApiService instance used by this factory

makeObject

public LdapConnection makeObject()
                          throws org.apache.directory.api.ldap.model.exception.LdapException

Specifically, we are creating a new connection based on the LdapConnection Factory we used to create this pool of connections. The default is to create bound connections.

Specified by:

makeObject in interface org.apache.commons.pool.PoolableObjectFactory<LdapConnection>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If unable to connect.

newLdapConnectionFactory

protected static LdapConnectionFactory newLdapConnectionFactory(LdapConnectionConfig config,
                                                                Class<? extends LdapConnectionFactory> connectionFactoryClass)

passivateObject

public void passivateObject(LdapConnection connection)
                     throws org.apache.directory.api.ldap.model.exception.LdapException

We don't do anything with the connection. It remains in the state it was before being used.

Specified by:

passivateObject in interface org.apache.commons.pool.PoolableObjectFactory<LdapConnection>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If unable to reconfigure and rebind.

setValidator

public void setValidator(LdapConnectionValidator validator)

Sets the validator to use when validation occurs. Note that validation will only occur if the connection pool was configured to validate. This means one of:

• setTestOnBorrow
• setTestWhileIdle
• setTestOnReturn

must have been set to true on the pool. The default validator is LookupLdapConnectionValidator.

Parameters:

validator - The validator

validateObject

public boolean validateObject(LdapConnection connection)

Validating a connection is done by checking the connection status.

Specified by:

validateObject in interface org.apache.commons.pool.PoolableObjectFactory<LdapConnection>