Package org.springframework.security.ldap.authentication

Class AbstractLdapAuthenticator

java.lang.Object

org.springframework.security.ldap.authentication.AbstractLdapAuthenticator

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.MessageSourceAware, LdapAuthenticator

Direct Known Subclasses:

BindAuthenticator, PasswordComparisonAuthenticator

public abstract class AbstractLdapAuthenticator
extends Object
implements LdapAuthenticator, org.springframework.beans.factory.InitializingBean, org.springframework.context.MessageSourceAware

Base class for the authenticator implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.support.MessageSourceAccessor	messages

Constructor Summary

Constructors

Constructor	Description
AbstractLdapAuthenticator(org.springframework.ldap.core.ContextSource contextSource)	Create an initialized instance with the ContextSource provided.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected org.springframework.ldap.core.ContextSource	getContextSource()
String[]	getUserAttributes()
protected List<String>	getUserDns(String username)	Builds list of possible DNs for the user, worked out from the userDnPatterns property.
protected LdapUserSearch	getUserSearch()
void	setMessageSource(org.springframework.context.MessageSource messageSource)
void	setUserAttributes(String[] userAttributes)	Sets the user attributes which will be retrieved from the directory.
void	setUserDnPatterns(String[] dnPattern)	Sets the pattern which will be used to supply a DN for the user.
void	setUserSearch(LdapUserSearch userSearch)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.security.ldap.authentication.LdapAuthenticator

authenticate

Field Details

messages

protected org.springframework.context.support.MessageSourceAccessor messages

Constructor Details

AbstractLdapAuthenticator

public AbstractLdapAuthenticator(org.springframework.ldap.core.ContextSource contextSource)

Create an initialized instance with the ContextSource provided.

Parameters:

contextSource - the ContextSource to use

Method Details

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

getContextSource

protected org.springframework.ldap.core.ContextSource getContextSource()

getUserAttributes

public String[] getUserAttributes()

getUserDns

protected List<String> getUserDns(String username)

Builds list of possible DNs for the user, worked out from the userDnPatterns property.

Parameters:

username - the user's login name

Returns:

the list of possible DN matches, empty if userDnPatterns wasn't set.

getUserSearch

protected LdapUserSearch getUserSearch()

setMessageSource

public void setMessageSource(@NonNull
 org.springframework.context.MessageSource messageSource)

Specified by:

setMessageSource in interface org.springframework.context.MessageSourceAware

setUserAttributes

public void setUserAttributes(String[] userAttributes)

Sets the user attributes which will be retrieved from the directory.

Parameters:

userAttributes - the set of user attributes to retrieve

setUserDnPatterns

public void setUserDnPatterns(String[] dnPattern)

Sets the pattern which will be used to supply a DN for the user. The pattern should be the name relative to the root DN. The pattern argument {0} will contain the username. An example would be "cn={0},ou=people".

Parameters:

dnPattern - the array of patterns which will be tried when converting a username to a DN.

setUserSearch

public void setUserSearch(LdapUserSearch userSearch)