org.jasig.cas.adaptors.ldap

Class AbstractLdapUsernamePasswordAuthenticationHandler

java.lang.Object

org.jasig.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

org.jasig.cas.authentication.handler.support.AbstractUsernamePasswordAuthenticationHandler

org.jasig.cas.adaptors.ldap.AbstractLdapUsernamePasswordAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler, NamedAuthenticationHandler, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

BindLdapAuthenticationHandler, FastBindLdapAuthenticationHandler

public abstract class AbstractLdapUsernamePasswordAuthenticationHandler
extends AbstractUsernamePasswordAuthenticationHandler
implements org.springframework.beans.factory.InitializingBean

Abstract class to handle common LDAP functionality.

Since:

3.0.3

Version:

$Revision$ $Date$

Author:

Scott Battaglia

Field Summary

Fields inherited from class org.jasig.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

log

Constructor Summary

Constructors

Constructor and Description
AbstractLdapUsernamePasswordAuthenticationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	afterPropertiesSetInternal()
protected org.springframework.ldap.core.ContextSource	getContextSource()
protected String	getFilter()
protected org.springframework.ldap.core.LdapTemplate	getLdapTemplate() Method to return the LdapTemplate
protected AuthenticationException	handleLdapError(Exception e) Available ONLY for subclasses that would want to customize how ldap error codes are handled
void	setContextSource(org.springframework.ldap.core.ContextSource contextSource) Method to set the datasource and generate a JdbcTemplate.
void	setFilter(String filter)
void	setIgnorePartialResultException(boolean ignorePartialResultException)
void	setLdapErrorDefinitions(List<LdapErrorDefinition> ldapErrorDefs)
protected void	setLdapTemplate(org.springframework.ldap.core.LdapTemplate ldapTemplate) Available ONLY for subclasses that are doing special things with the ContextSource.

Methods inherited from class org.jasig.cas.authentication.handler.support.AbstractUsernamePasswordAuthenticationHandler

authenticateUsernamePasswordInternal, doAuthentication, getPasswordEncoder, getPrincipalNameTransformer, setClassToSupport, setPasswordEncoder, setPrincipalNameTransformer, setSupportSubClasses, supports

Methods inherited from class org.jasig.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

authenticate, getName, postAuthenticate, preAuthenticate, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLdapUsernamePasswordAuthenticationHandler

public AbstractLdapUsernamePasswordAuthenticationHandler()

Method Detail

setContextSource

public final void setContextSource(org.springframework.ldap.core.ContextSource contextSource)

Method to set the datasource and generate a JdbcTemplate.

Parameters:

contextSource - the datasource to use.

setIgnorePartialResultException

public final void setIgnorePartialResultException(boolean ignorePartialResultException)

setLdapErrorDefinitions

public void setLdapErrorDefinitions(List<LdapErrorDefinition> ldapErrorDefs)

getLdapTemplate

protected final org.springframework.ldap.core.LdapTemplate getLdapTemplate()

Method to return the LdapTemplate

Returns:

a fully created LdapTemplate.

getContextSource

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

getFilter

protected final String getFilter()

afterPropertiesSet

public final void afterPropertiesSet()
                              throws Exception

Specified by:

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

Throws:

Exception

setLdapTemplate

protected final void setLdapTemplate(org.springframework.ldap.core.LdapTemplate ldapTemplate)

Available ONLY for subclasses that are doing special things with the ContextSource.

Parameters:

ldapTemplate - the LDAPTemplate to use.

afterPropertiesSetInternal

protected void afterPropertiesSetInternal()
                                   throws Exception

Throws:

Exception

setFilter

public final void setFilter(String filter)

Parameters:

filter - The filter to set.

handleLdapError

protected AuthenticationException handleLdapError(Exception e)

Available ONLY for subclasses that would want to customize how ldap error codes are handled

Parameters:

e - The ldap exception that occurred.

Returns:

an instance of AuthenticationException