org.springframework.ldap.core.support
Class AbstractContextSource

java.lang.Object
  org.springframework.ldap.core.support.AbstractContextSource

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, ContextSource, BaseLdapPathContextSource, BaseLdapPathSource

Direct Known Subclasses:

DirContextSource, LdapContextSource

public abstract class AbstractContextSource
extends java.lang.Object
implements BaseLdapPathContextSource, org.springframework.beans.factory.InitializingBean

Abstract implementation of the ContextSource interface. By default, returns an authenticated DirContext implementation for both read-only and read-write operations. To have an anonymous environment created for read-only operations, set the anonymousReadOnly property to true.

Implementing classes need to implement getDirContextInstance(Hashtable) to create a DirContext instance of the desired type.

If an AuthenticationSource is set, this will be used for getting user principal and password for each new connection, otherwise a default one will be created using the specified userDn and password.

Note: When using implementations of this class outside of a Spring Context it is necessary to call afterPropertiesSet() when all properties are set, in order to finish up initialization.

Author:

Mattias Arthursson, Adam Skogman, Ulrik Sandberg

See Also:

LdapTemplate, DefaultDirObjectFactory, LdapContextSource, DirContextSource

Field Summary

protected java.lang.String	password
static java.lang.String	SUN_LDAP_POOLING_FLAG
protected java.lang.String	userDn

Constructor Summary

AbstractContextSource()

Method Summary

void	afterPropertiesSet() Checks that all necessary data is set and that there is no compatibility issues, after which the instance is initialized.
protected java.lang.String	assembleProviderUrlString(java.lang.String[] ldapUrls) Assemble a valid url String from all registered urls to add as PROVIDER_URL to the environment.
protected javax.naming.directory.DirContext	createContext(java.util.Hashtable environment) Create a DirContext using the supplied environment.
protected java.util.Hashtable	getAnonymousEnv()
protected java.util.Hashtable	getAuthenticatedEnv()
AuthenticationSource	getAuthenticationSource() Get the authentication source.
protected DistinguishedName	getBase() Get the base suffix from which all operations should originate.
DistinguishedName	getBaseLdapPath() Get the base LDAP path as a DistinguishedName.
java.lang.String	getBaseLdapPathAsString() Get the base LDAP path as a String.
java.lang.Class	getContextFactory() Get the context factory.
protected abstract javax.naming.directory.DirContext	getDirContextInstance(java.util.Hashtable environment) Implement in subclass to create a DirContext of the desired type (e.g.
java.lang.Class	getDirObjectFactory() Get the DirObjectFactory to use.
javax.naming.directory.DirContext	getReadOnlyContext() Gets a read-only DirContext.
javax.naming.directory.DirContext	getReadWriteContext() Gets a read-write DirContext.
java.lang.String[]	getUrls() Get the urls of the LDAP servers.
boolean	isAnonymousReadOnly() Get whether an anonymous environment should be used for read-only operations.
boolean	isPooled() Get whether the pooling flag should be set.
void	setAnonymousReadOnly(boolean anonymousReadOnly) Set whether an anonymous environment should be used for read-only operations.
void	setAuthenticationSource(AuthenticationSource authenticationSource) Set the authentication source to use when retrieving user principal and credentials.
void	setBase(java.lang.String base) Set the base suffix from which all operations should origin.
void	setBaseEnvironmentProperties(java.util.Map baseEnvironmentProperties) If any custom environment properties are needed, these can be set using this method.
void	setCacheEnvironmentProperties(boolean cacheEnvironmentProperties) Set whether environment properties should be cached between requsts for anonymous environment.
void	setContextFactory(java.lang.Class contextFactory) Set the context factory.
void	setDirObjectFactory(java.lang.Class dirObjectFactory) Set the DirObjectFactory to use.
void	setPassword(java.lang.String password) Set the password (credentials) to use for getting authenticated contexts.
void	setPooled(boolean pooled) Set whether the pooling flag should be set.
protected void	setupAuthenticatedEnvironment(java.util.Hashtable env) Default implementation of setting the environment up to be authenticated.
void	setUrl(java.lang.String url) Set the url of the LDAP server.
void	setUrls(java.lang.String[] urls) Set the urls of the LDAP servers.
void	setUserDn(java.lang.String userDn) Set the user distinguished name (principal) to use for getting authenticated contexts.
void	setUserName(java.lang.String userName) Deprecated. Use setUserDn(String) instead.

Methods inherited from class java.lang.Object

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

Field Detail

userDn

protected java.lang.String userDn

password

protected java.lang.String password

SUN_LDAP_POOLING_FLAG

public static final java.lang.String SUN_LDAP_POOLING_FLAG

See Also:

Constant Field Values

Constructor Detail

AbstractContextSource

public AbstractContextSource()

Method Detail

getReadOnlyContext

public javax.naming.directory.DirContext getReadOnlyContext()

Description copied from interface: ContextSource

Gets a read-only DirContext. The returned DirContext must be possible to perform read-only operations on.

Specified by:

getReadOnlyContext in interface ContextSource

Returns:

A DirContext instance, never null.

getReadWriteContext

public javax.naming.directory.DirContext getReadWriteContext()

Description copied from interface: ContextSource

Gets a read-write DirContext.

Specified by:

getReadWriteContext in interface ContextSource

Returns:

A DirContext instance, never null.

setupAuthenticatedEnvironment

protected void setupAuthenticatedEnvironment(java.util.Hashtable env)

Default implementation of setting the environment up to be authenticated. Override in subclass if necessary.

Parameters:

env - the environment to modify.

assembleProviderUrlString

protected java.lang.String assembleProviderUrlString(java.lang.String[] ldapUrls)

Assemble a valid url String from all registered urls to add as PROVIDER_URL to the environment.

Parameters:

ldapUrls - all individual url Strings.

Returns:

the full url String

setBase

public void setBase(java.lang.String base)

Set the base suffix from which all operations should origin. If a base suffix is set, you will not have to (and, indeed, must not) specify the full distinguished names in any operations performed.

Parameters:

base - the base suffix.

getBase

protected DistinguishedName getBase()

Get the base suffix from which all operations should originate. If a base suffix is set, you will not have to (and, indeed, must not) specify the full distinguished names in any operations performed.

Returns:

the base suffix

getBaseLdapPath

public DistinguishedName getBaseLdapPath()

Description copied from interface: BaseLdapPathSource

Get the base LDAP path as a DistinguishedName.

Specified by:

getBaseLdapPath in interface BaseLdapPathSource

Returns:

the base LDAP path as a DistinguishedName. The path will be empty if no base path is specified.

getBaseLdapPathAsString

public java.lang.String getBaseLdapPathAsString()

Description copied from interface: BaseLdapPathSource

Get the base LDAP path as a String.

Specified by:

getBaseLdapPathAsString in interface BaseLdapPathSource

Returns:

the base LDAP path as a An empty String will be returned if no base path is specified.

createContext

protected javax.naming.directory.DirContext createContext(java.util.Hashtable environment)

Create a DirContext using the supplied environment.

Parameters:

environment - the Ldap environment to use when creating the DirContext.

Returns:

a new DirContext implpementation initialized with the supplied environment.

setContextFactory

public void setContextFactory(java.lang.Class contextFactory)

Set the context factory. Default is com.sun.jndi.ldap.LdapCtxFactory.

Parameters:

contextFactory - the context factory used when creating Contexts.

getContextFactory

public java.lang.Class getContextFactory()

Get the context factory.

Returns:

the context factory used when creating Contexts.

setDirObjectFactory

public void setDirObjectFactory(java.lang.Class dirObjectFactory)

Set the DirObjectFactory to use. Default is DefaultDirObjectFactory. The specified class needs to be an implementation of javax.naming.spi.DirObjectFactory. Note: Setting this value to null may have cause connection leaks when using ContextMapper methods in LdapTemplate.

Parameters:

dirObjectFactory - the DirObjectFactory to be used. Null means that no DirObjectFactory will be used.

getDirObjectFactory

public java.lang.Class getDirObjectFactory()

Get the DirObjectFactory to use.

Returns:

the DirObjectFactory to be used. null means that no DirObjectFactory will be used.

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Checks that all necessary data is set and that there is no compatibility issues, after which the instance is initialized. Note that you need to call this method explicitly after setting all desired properties if using the class outside of a Spring Context.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

setPassword

public void setPassword(java.lang.String password)

Set the password (credentials) to use for getting authenticated contexts.

Parameters:

password - the password.

setUserDn

public void setUserDn(java.lang.String userDn)

Set the user distinguished name (principal) to use for getting authenticated contexts.

Parameters:

userDn - the user distinguished name.

setUserName

public void setUserName(java.lang.String userName)

Deprecated. Use setUserDn(String) instead.

Set the user distinguished name (principal) to use for getting authenticated contexts.

Parameters:

userName - the user distinguished name.

setUrls

public void setUrls(java.lang.String[] urls)

Set the urls of the LDAP servers. Use this method if several servers are required.

Parameters:

urls - the urls of all servers.

getUrls

public java.lang.String[] getUrls()

Get the urls of the LDAP servers.

Returns:

the urls of all servers.

setUrl

public void setUrl(java.lang.String url)

Set the url of the LDAP server. Utility method if only one server is used.

Parameters:

url - the url of the LDAP server.

setPooled

public void setPooled(boolean pooled)

Set whether the pooling flag should be set. Default is true. Note that since LDAP pooling is system wide, full configuration of this needs be done using system parameters as specified in the LDAP/JNDI documentation. Also note, that pooling is done on user dn basis, i.e. each individually authenticated connection will be pooled separately. This means that LDAP pooling will be most efficient using anonymous connections or connections authenticated using one single system user.

Parameters:

pooled - whether Contexts should be pooled.

isPooled

public boolean isPooled()

Get whether the pooling flag should be set.

Returns:

whether Contexts should be pooled.

setBaseEnvironmentProperties

public void setBaseEnvironmentProperties(java.util.Map baseEnvironmentProperties)

If any custom environment properties are needed, these can be set using this method.

Parameters:

baseEnvironmentProperties -

getAnonymousEnv

protected java.util.Hashtable getAnonymousEnv()

getAuthenticatedEnv

protected java.util.Hashtable getAuthenticatedEnv()

setAuthenticationSource

public void setAuthenticationSource(AuthenticationSource authenticationSource)

Set the authentication source to use when retrieving user principal and credentials.

Parameters:

authenticationSource - the AuthenticationSource that will provide user info.

getAuthenticationSource

public AuthenticationSource getAuthenticationSource()

Get the authentication source.

Returns:

the AuthenticationSource that will provide user info.

setCacheEnvironmentProperties

public void setCacheEnvironmentProperties(boolean cacheEnvironmentProperties)

Set whether environment properties should be cached between requsts for anonymous environment. Default is true; setting this property to false causes the environment Hashmap to be rebuilt from the current property settings of this instance between each request for an anonymous environment.

Parameters:

cacheEnvironmentProperties - true causes that the anonymous environment properties should be cached, false causes the Hashmap to be rebuilt for each request.

setAnonymousReadOnly

public void setAnonymousReadOnly(boolean anonymousReadOnly)

Set whether an anonymous environment should be used for read-only operations. Default is false.

Parameters:

anonymousReadOnly - true if an anonymous environment should be used for read-only operations, false otherwise.

isAnonymousReadOnly

public boolean isAnonymousReadOnly()

Get whether an anonymous environment should be used for read-only operations.

Returns:

true if an anonymous environment should be used for read-only operations, false otherwise.

getDirContextInstance

protected abstract javax.naming.directory.DirContext getDirContextInstance(java.util.Hashtable environment)
                                                                    throws javax.naming.NamingException

Implement in subclass to create a DirContext of the desired type (e.g. InitialDirContext or InitialLdapContext).

Parameters:

environment - the environment to use when creating the instance.

Returns:

a new DirContext instance.

Throws:

javax.naming.NamingException - if one is encountered when creating the instance.