org.jasig.cas.authentication

Class AbstractAuthenticationManager

java.lang.Object

org.jasig.cas.authentication.AbstractAuthenticationManager

All Implemented Interfaces:

AuthenticationManager

Direct Known Subclasses:

AuthenticationManagerImpl, DirectMappingAuthenticationManagerImpl, LinkedAuthenticationHandlerAndCredentialsToPrincipalResolverAuthenticationManager

public abstract class AbstractAuthenticationManager
extends Object
implements AuthenticationManager

Since:

3.3.5

Version:

$Revision$ $Date$

Author:

Scott Battaglia

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractAuthenticationManager.Pair<A,B>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log Log instance for logging events, errors, warnings, etc.

Fields inherited from interface org.jasig.cas.authentication.AuthenticationManager

AUTHENTICATION_METHOD_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
AbstractAuthenticationManager()

Method Summary

Methods

Modifier and Type	Method and Description
Authentication	authenticate(Credentials credentials) Method to validate the credentials provided.
protected abstract AbstractAuthenticationManager.Pair<AuthenticationHandler,Principal>	authenticateAndObtainPrincipal(Credentials credentials) Follows the same rules as the "authenticate" method (i.e.
protected void	logAuthenticationHandlerError(String handlerName, Credentials credentials, Exception e) Logs the exception occurred as an error.
void	setAuthenticationMetaDataPopulators(List<AuthenticationMetaDataPopulator> authenticationMetaDataPopulators)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

Log instance for logging events, errors, warnings, etc.

Constructor Detail

AbstractAuthenticationManager

public AbstractAuthenticationManager()

Method Detail

authenticate

public final Authentication authenticate(Credentials credentials)
                                  throws AuthenticationException

Description copied from interface: AuthenticationManager

Method to validate the credentials provided. On successful validation, a fully populated Authentication object will be returned. Typically this will involve resolving a principal and providing any additional attributes, but specifics are left to the individual implementations to determine. Failure to authenticate is considered an exceptional case, and an AuthenticationException is thrown.

Specified by:

authenticate in interface AuthenticationManager

Parameters:

credentials - The credentials provided for authentication.

Returns:

fully populated Authentication object.

Throws:

AuthenticationException - if unable to determine validity of credentials or there is an extenuating circumstance related to credentials (i.e. Account locked).

setAuthenticationMetaDataPopulators

public final void setAuthenticationMetaDataPopulators(List<AuthenticationMetaDataPopulator> authenticationMetaDataPopulators)

Parameters:

authenticationMetaDataPopulators - the authenticationMetaDataPopulators to set.

authenticateAndObtainPrincipal

protected abstract AbstractAuthenticationManager.Pair<AuthenticationHandler,Principal> authenticateAndObtainPrincipal(Credentials credentials)
                                                                                                               throws AuthenticationException

Follows the same rules as the "authenticate" method (i.e. should only return a fully populated object, or throw an exception)

Parameters:

credentials - the credentials to check

Returns:

the pair of authentication handler and principal. CANNOT be NULL.

Throws:

AuthenticationException - if there is an error authenticating.

logAuthenticationHandlerError

protected void logAuthenticationHandlerError(String handlerName,
                                 Credentials credentials,
                                 Exception e)

Logs the exception occurred as an error.

Parameters:

handlerName - The class name of the authentication handler.

credentials - Client credentials subject to authentication.

e - The exception that has occurred during authentication attempt.