edu.amc.sakai.user

Interface LdapConnectionManager

All Known Implementing Classes:

PoolingLdapConnectionManager, SimpleLdapConnectionManager

public interface LdapConnectionManager

Implementations manage LDAPConnection allocation.

Author:

Dan McCallum, Unicon Inc, John Lewis, Unicon Inc

See Also:

LdapConnectionManager

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
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.
void	returnConnection(com.novell.ldap.LDAPConnection conn) Return an LDAPConnection.
void	setConfig(LdapConnectionManagerConfig config) Assign the LDAPConnection management configuration.

Method Detail

init

void init()

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

getConnection

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

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

Returns:

a connected LDAPConnection

Throws:

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

getBoundConnection

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

Retrieve a bound LDAPConnection using the indicated credentials

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

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

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

Parameters:

conn - an LDAPConnection that you no longer need

setConfig

void setConfig(LdapConnectionManagerConfig config)

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

Parameters:

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

getConfig

LdapConnectionManagerConfig getConfig()

Retrieve the currently assigned LdapConnectionManagerConfig.

Returns:

the currently assigned LdapConnectionManagerConfig, if any

destroy

void destroy()

Shuts down an instance. Usually called by Spring.