org.jasig.cas.web.flow

Class AuthenticationExceptionHandler

java.lang.Object

org.jasig.cas.web.flow.AuthenticationExceptionHandler

public class AuthenticationExceptionHandler
extends Object

Performs two important error handling functions on an AuthenticationException raised from the authentication layer:

1. Maps handler errors onto message bundle strings for display to user.
2. Determines the next webflow state by comparing handler erors against errors in list order. The first entry that matches determines the outcome state, which is the simple class name of the exception.

Since:

4.0

Author:

Marvin S. Addison

Constructor Summary

Constructors

Constructor and Description
AuthenticationExceptionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
List<Class<? extends Exception>>	getErrors()
String	handle(AuthenticationException e, org.springframework.binding.message.MessageContext messageContext) Maps an authentication exception onto a state name equal to the simple class name of the AuthenticationException.getHandlerErrors() with highest precedence.
void	setErrors(List<Class<? extends Exception>> errors) Sets the list of errors that this class knows how to handle.
void	setMessageBundlePrefix(String prefix) Sets the message bundle prefix appended to exception class names to create a message bundle key for that particular error.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationExceptionHandler

public AuthenticationExceptionHandler()

Method Detail

setErrors

public void setErrors(List<Class<? extends Exception>> errors)

Sets the list of errors that this class knows how to handle.

Parameters:

errors - List of errors in order of descending precedence.

getErrors

public final List<Class<? extends Exception>> getErrors()

setMessageBundlePrefix

public void setMessageBundlePrefix(String prefix)

Sets the message bundle prefix appended to exception class names to create a message bundle key for that particular error.

Parameters:

prefix - Prefix appended to exception names.

handle

public String handle(AuthenticationException e,
            org.springframework.binding.message.MessageContext messageContext)

Maps an authentication exception onto a state name equal to the simple class name of the AuthenticationException.getHandlerErrors() with highest precedence. Also sets an ERROR severity message in the message context of the form [messageBundlePrefix][exceptionClassSimpleName] for each handler error that is configured. If not match is found, is returned.

Parameters:

e - Authentication error to handle.

Returns:

Name of next flow state to transition to or