edu.amc.sakai.user

Class SimpleLdapConnectionManager

java.lang.Object

edu.amc.sakai.user.SimpleLdapConnectionManager

All Implemented Interfaces:

LdapConnectionManager

Direct Known Subclasses:

PoolingLdapConnectionManager

public class SimpleLdapConnectionManager
extends Object
implements LdapConnectionManager

Allocates connected, constrained, and optionally bound and secure LDAPConnections

Author:

Dan McCallum, Unicon Inc, John Lewis, Unicon Inc

See Also:

LdapConnectionManagerConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEYSTORE_LOCATION_SYS_PROP_KEY
static String	KEYSTORE_PASSWORD_SYS_PROP_KEY

Constructor Summary

Constructors

Constructor and Description
SimpleLdapConnectionManager()

Method Summary

Modifier and Type	Method and Description
protected void	applyConstraints(com.novell.ldap.LDAPConnection conn) Applies LDAPConstraints to the specified LDAPConnection.
protected void	connect(com.novell.ldap.LDAPConnection conn) Connects the specified LDAPConnection to the currently configured host and port.
void	destroy() Shuts down an instance.
com.novell.ldap.LDAPConnection	getBoundConnection(String dn, String pw) Retrieve a bound LDAPConnection using the indicated credentials
LdapConnectionManagerConfig	getConfig() Retrieve the currently assigned LdapConnectionManagerConfig.
com.novell.ldap.LDAPConnection	getConnection() Retrieve an LDAPConnection -- the connection may already be bound depending on the configuration
void	init() Initializes an instance for use, typically by digesting the contents of the assigned LdapConnectionManagerConfig.
protected void	initKeystoreLocation() Caches a keystore location as a system property.
protected void	initKeystorePassword() Caches a keystore password as a system property.
protected boolean	isTlsSocketFactory()
protected com.novell.ldap.LDAPConnection	newConnection()
protected void	postConnect(com.novell.ldap.LDAPConnection conn)
void	returnConnection(com.novell.ldap.LDAPConnection conn) Return an LDAPConnection.
void	setConfig(LdapConnectionManagerConfig config) Assign the LDAPConnection management configuration.

Methods inherited from class java.lang.Object

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

Field Detail

KEYSTORE_LOCATION_SYS_PROP_KEY

public static final String KEYSTORE_LOCATION_SYS_PROP_KEY

See Also:

Constant Field Values

KEYSTORE_PASSWORD_SYS_PROP_KEY

public static final String KEYSTORE_PASSWORD_SYS_PROP_KEY

See Also:

Constant Field Values

Constructor Detail

SimpleLdapConnectionManager

public SimpleLdapConnectionManager()

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

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

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

Retrieve a bound LDAPConnection using the indicated credentials

Specified by:

getBoundConnection in interface LdapConnectionManager

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

newConnection

protected com.novell.ldap.LDAPConnection newConnection()
                                                throws com.novell.ldap.LDAPException

Throws:

com.novell.ldap.LDAPException

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

Parameters:

conn - an LDAPConnection that you no longer need

setConfig

public void setConfig(LdapConnectionManagerConfig config)

Assign the LDAPConnection management configuration. Should typically be invoked once and followed by a call to init().

Specified by:

setConfig in interface LdapConnectionManager

Parameters:

config - a reference to a LdapConnectionManagerConfig. Should be cacheable without defensive copying.

getConfig

public LdapConnectionManagerConfig getConfig()

Retrieve the currently assigned LdapConnectionManagerConfig.

Specified by:

getConfig in interface LdapConnectionManager

Returns:

the currently assigned LdapConnectionManagerConfig, if any

initKeystorePassword

protected void initKeystorePassword()

Caches a keystore password as a system property. No-op if the KEYSTORE_PASSWORD_SYS_PROP_KEY system property has a non-null value. Otherwise caches the keystore password from the currently assigned LdapConnectionManagerConfig.

Parameters:

config -

Throws:

NullPointerException - if a non-null keystore password cannot be resolved

initKeystoreLocation

protected void initKeystoreLocation()

Caches a keystore location as a system property. No-op if the KEYSTORE_LOCATION_SYS_PROP_KEY system property has a non-null value. Otherwise caches the keystore location from the currently assigned LdapConnectionManagerConfig.

Parameters:

config -

Throws:

NullPointerException - if a non-null keystore location cannot be resolved

applyConstraints

protected void applyConstraints(com.novell.ldap.LDAPConnection conn)

Applies LDAPConstraints to the specified LDAPConnection. Implemented to assign timeLimit and referralFollowing constraint values retrieved from the currently assigned LdapConnectionManagerConfig.

Parameters:

conn -

connect

protected void connect(com.novell.ldap.LDAPConnection conn)
                throws com.novell.ldap.LDAPException

Connects the specified LDAPConnection to the currently configured host and port.

Parameters:

conn - an LDAPConnection

Throws:

com.novell.ldap.LDAPConnection - if the connect attempt fails

com.novell.ldap.LDAPException

postConnect

protected void postConnect(com.novell.ldap.LDAPConnection conn)
                    throws com.novell.ldap.LDAPException

Throws:

com.novell.ldap.LDAPException

isTlsSocketFactory

protected boolean isTlsSocketFactory()

destroy

public void destroy()

Shuts down an instance. Usually called by Spring.

Specified by:

destroy in interface LdapConnectionManager