org.jasig.cas.authentication.handler.support

Class AbstractPreAndPostProcessingAuthenticationHandler

java.lang.Object

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

All Implemented Interfaces:

AuthenticationHandler, NamedAuthenticationHandler

Direct Known Subclasses:

AbstractUsernamePasswordAuthenticationHandler

public abstract class AbstractPreAndPostProcessingAuthenticationHandler
extends Object
implements NamedAuthenticationHandler

Abstract authentication handler that allows deployers to utilize the bundled AuthenticationHandlers while providing a mechanism to perform tasks before and after authentication.

Since:

3.1

Version:

$Revision$ $Date$

Author:

Scott Battaglia

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log Instance of logging for subclasses.

Constructor Summary

Constructors

Constructor and Description
AbstractPreAndPostProcessingAuthenticationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate(Credentials credentials) Method to determine if the credentials supplied are valid.
protected abstract boolean	doAuthentication(Credentials credentials)
String	getName()
protected boolean	postAuthenticate(Credentials credentials, boolean authenticated) Method to execute after authentication occurs.
protected boolean	preAuthenticate(Credentials credentials) Method to execute before authentication occurs.
void	setName(String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.cas.authentication.handler.AuthenticationHandler

supports

Field Detail

log

protected org.slf4j.Logger log

Instance of logging for subclasses.

Constructor Detail

AbstractPreAndPostProcessingAuthenticationHandler

public AbstractPreAndPostProcessingAuthenticationHandler()

Method Detail

preAuthenticate

protected boolean preAuthenticate(Credentials credentials)

Method to execute before authentication occurs.

Parameters:

credentials - the Credentials supplied

Returns:

true if authentication should continue, false otherwise.

postAuthenticate

protected boolean postAuthenticate(Credentials credentials,
                       boolean authenticated)

Method to execute after authentication occurs.

Parameters:

credentials - the supplied credentials

authenticated - the result of the authentication attempt.

Returns:

true if the handler should return true, false otherwise.

setName

public final void setName(String name)

getName

public final String getName()

Specified by:

getName in interface NamedAuthenticationHandler

authenticate

public final boolean authenticate(Credentials credentials)
                           throws AuthenticationException

Description copied from interface: AuthenticationHandler

Method to determine if the credentials supplied are valid.

Specified by:

authenticate in interface AuthenticationHandler

Parameters:

credentials - The credentials to validate.

Returns:

true if valid, return false otherwise.

Throws:

AuthenticationException - An AuthenticationException can contain details about why a particular authentication request failed.

doAuthentication

protected abstract boolean doAuthentication(Credentials credentials)
                                     throws AuthenticationException

Throws:

AuthenticationException