edu.amc.sakai.user

Class PoolingLdapConnectionManager

java.lang.Object

edu.amc.sakai.user.SimpleLdapConnectionManager

edu.amc.sakai.user.PoolingLdapConnectionManager

All Implemented Interfaces:

LdapConnectionManager

public class PoolingLdapConnectionManager
extends SimpleLdapConnectionManager

Allocates connected, constrained, bound and optionally secure LDAPConnections. Uses commons-pool to provide a pool of connections instead of creating a new connection for each request. Originally tried implementing this with om.novell.ldap.connectionpool.PoolManager, but it did not handle recovering connections that had suffered a network error or connections that were never returned but dropped out of scope.

Author:

John Lewis, Unicon Inc

See Also:

LdapConnectionManagerConfig, PooledLDAPConnection, PooledLDAPConnectionFactory

Field Summary

Fields inherited from class edu.amc.sakai.user.SimpleLdapConnectionManager

KEYSTORE_LOCATION_SYS_PROP_KEY, KEYSTORE_PASSWORD_SYS_PROP_KEY

Constructor Summary

Constructors

Constructor and Description
PoolingLdapConnectionManager()

Method Summary

Modifier and Type	Method and Description
void	destroy() Shuts down an instance.
com.novell.ldap.LDAPConnection	getBoundConnection(String dn, String pw) Retrieve a bound LDAPConnection using the indicated credentials
com.novell.ldap.LDAPConnection	getConnection() Retrieve an LDAPConnection -- the connection may already be bound depending on the configuration
PooledLDAPConnectionFactory	getFactory()
void	init() Initializes an instance for use, typically by digesting the contents of the assigned LdapConnectionManagerConfig.
void	returnConnection(com.novell.ldap.LDAPConnection conn) Return an LDAPConnection.
void	setFactory(PooledLDAPConnectionFactory factory)
protected void	setPool(org.apache.commons.pool.ObjectPool pool) Assign a pool implementation.

Methods inherited from class edu.amc.sakai.user.SimpleLdapConnectionManager

applyConstraints, connect, getConfig, initKeystoreLocation, initKeystorePassword, isTlsSocketFactory, newConnection, postConnect, setConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

PoolingLdapConnectionManager

public PoolingLdapConnectionManager()

Method Detail

init

public void init()

Initializes an instance for use, typically by digesting the contents of the assigned LdapConnectionManagerConfig. Usually called by Spring.

Specified by:

init in interface LdapConnectionManager

Overrides:

init in class SimpleLdapConnectionManager

getConnection

public com.novell.ldap.LDAPConnection getConnection()
                                             throws com.novell.ldap.LDAPException

Retrieve an LDAPConnection -- the connection may already be bound depending on the configuration

Specified by:

getConnection in interface LdapConnectionManager

Overrides:

getConnection in class SimpleLdapConnectionManager

Returns:

a connected LDAPConnection

Throws:

com.novell.ldap.LDAPException - if the LDAPConnection allocation fails

getBoundConnection

public com.novell.ldap.LDAPConnection getBoundConnection(String dn,
                                                         String pw)
                                                  throws com.novell.ldap.LDAPException

Description copied from class: SimpleLdapConnectionManager

Retrieve a bound LDAPConnection using the indicated credentials

Specified by:

getBoundConnection in interface LdapConnectionManager

Overrides:

getBoundConnection in class SimpleLdapConnectionManager

Parameters:

dn - the distringuished name for binding

pw - the password for binding

Returns:

a connected LDAPConnection

Throws:

com.novell.ldap.LDAPException - if the LDAPConnection allocation fails

returnConnection

public void returnConnection(com.novell.ldap.LDAPConnection conn)

Return an LDAPConnection. This can allow for connections to be pooled instead of just destroyed.

Specified by:

returnConnection in interface LdapConnectionManager

Overrides:

returnConnection in class SimpleLdapConnectionManager

Parameters:

conn - an LDAPConnection that you no longer need

destroy

public void destroy()

Shuts down an instance. Usually called by Spring.

Specified by:

destroy in interface LdapConnectionManager

Overrides:

destroy in class SimpleLdapConnectionManager

getFactory

public PooledLDAPConnectionFactory getFactory()

setFactory

public void setFactory(PooledLDAPConnectionFactory factory)

setPool

protected void setPool(org.apache.commons.pool.ObjectPool pool)

Assign a pool implementation. If not specified, one will be constructed by init(). If specified, setFactory(PooledLDAPConnectionFactory) will have no effect.

This method exists almost entirely for testing purposes.

Parameters:

pool - the pool to cache; accepts null