Package org.springframework.security.ldap.authentication

Class BindAuthenticator

java.lang.Object

org.springframework.security.ldap.authentication.AbstractLdapAuthenticator

org.springframework.security.ldap.authentication.BindAuthenticator

All Implemented Interfaces:

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

public class BindAuthenticator
extends AbstractLdapAuthenticator

An authenticator which binds as a user.

See Also:

• AbstractLdapAuthenticator

Field Summary

Fields inherited from class org.springframework.security.ldap.authentication.AbstractLdapAuthenticator

messages

Constructor Summary

Constructors

Constructor	Description
BindAuthenticator(org.springframework.ldap.core.support.BaseLdapPathContextSource contextSource)	Create an initialized instance using the BaseLdapPathContextSource provided.

Method Summary

Modifier and Type	Method	Description
org.springframework.ldap.core.DirContextOperations	authenticate(Authentication authentication)	Authenticates as a user and obtains additional user information from the directory.
protected void	handleBindException(String userDn, String username, Throwable cause)	Allows subclasses to inspect the exception thrown by an attempt to bind with a particular DN.
void	setAlsoHandleJavaxNamingBindExceptions(boolean alsoHandleJavaxNamingBindExceptions)	Set whether javax-based bind exceptions should also be delegated to #handleBindException (only Spring-based bind exceptions are handled by default)

Methods inherited from class org.springframework.security.ldap.authentication.AbstractLdapAuthenticator

afterPropertiesSet, getContextSource, getUserAttributes, getUserDns, getUserSearch, setMessageSource, setUserAttributes, setUserDnPatterns, setUserSearch

Methods inherited from class java.lang.Object

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

Constructor Details

BindAuthenticator

public BindAuthenticator(org.springframework.ldap.core.support.BaseLdapPathContextSource contextSource)

Create an initialized instance using the BaseLdapPathContextSource provided.

Parameters:

contextSource - the BaseLdapPathContextSource instance against which bind operations will be performed.

Method Details

authenticate

public org.springframework.ldap.core.DirContextOperations authenticate(Authentication authentication)

Description copied from interface: LdapAuthenticator

Authenticates as a user and obtains additional user information from the directory.

Parameters:

authentication - the authentication request

Returns:

the details of the successfully authenticated user.

handleBindException

protected void handleBindException(String userDn,
 String username,
 Throwable cause)

Allows subclasses to inspect the exception thrown by an attempt to bind with a particular DN. The default implementation just reports the failure to the debug logger.

setAlsoHandleJavaxNamingBindExceptions

public void setAlsoHandleJavaxNamingBindExceptions(boolean alsoHandleJavaxNamingBindExceptions)

Set whether javax-based bind exceptions should also be delegated to #handleBindException (only Spring-based bind exceptions are handled by default)

For passivity reasons, defaults to false, though may change to true in future releases.

Parameters:

alsoHandleJavaxNamingBindExceptions - - whether to delegate javax-based bind exceptions to #handleBindException

Since:

6.4