org.apereo.cas.web.flow

Class AuthenticationExceptionHandler

java.lang.Object

org.apereo.cas.web.flow.AuthenticationExceptionHandler

public class AuthenticationExceptionHandler
extends java.lang.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 errors 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.0

Constructor Summary

Constructors

Constructor and Description
AuthenticationExceptionHandler()

Method Summary

Modifier and Type	Method and Description
boolean	containsCustomErrors() Package-private helper method to aid in testing.
java.util.Set<java.lang.Class<? extends java.lang.Exception>>	getErrors()
java.lang.String	handle(java.lang.Exception e, org.springframework.binding.message.MessageContext messageContext) Maps an authentication exception onto a state name.
protected java.lang.String	handleAbstractTicketException(org.apereo.cas.ticket.AbstractTicketException e, org.springframework.binding.message.MessageContext messageContext) Maps an AbstractTicketException onto a state name equal to the simple class name of the exception with highest precedence.
protected java.lang.String	handleAuthenticationException(org.apereo.cas.authentication.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(java.util.List<java.lang.Class<? extends java.lang.Exception>> errors) Sets the list of custom exceptions that this class knows how to handle.
void	setMessageBundlePrefix(java.lang.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(java.util.List<java.lang.Class<? extends java.lang.Exception>> errors)

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

This implementation adds the provided list of exceptions to the default list or just returns if the provided list is empty.

This implementation relies on Spring's property source configurer, SpEL, and conversion service infrastructure facilities to convert and inject the collection from cas properties.

This method is thread-safe. It should only be called by the Spring container during application context bootstrap or unit tests.

Parameters:

errors - List of errors in order of descending precedence.

getErrors

public java.util.Set<java.lang.Class<? extends java.lang.Exception>> getErrors()

containsCustomErrors

public final boolean containsCustomErrors()

Package-private helper method to aid in testing.

Returns:

true if any custom errors have been added, false otherwise.

setMessageBundlePrefix

public void setMessageBundlePrefix(java.lang.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 java.lang.String handle(java.lang.Exception e,
                               org.springframework.binding.message.MessageContext messageContext)

Maps an authentication exception onto a state name. Also sets an ERROR severity message in the message context.

Parameters:

e - Authentication error to handle.

messageContext - the spring message context

Returns:

Name of next flow state to transition to or

handleAuthenticationException

protected java.lang.String handleAuthenticationException(org.apereo.cas.authentication.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 for the first handler error that is configured. If no match is found, is returned.

Parameters:

e - Authentication error to handle.

messageContext - the spring message context

Returns:

Name of next flow state to transition to or

handleAbstractTicketException

protected java.lang.String handleAbstractTicketException(org.apereo.cas.ticket.AbstractTicketException e,
                                                         org.springframework.binding.message.MessageContext messageContext)

Maps an AbstractTicketException onto a state name equal to the simple class name of the exception with highest precedence. Also sets an ERROR severity message in the message context with the error code found in RootCasException.getCode(). If no match is found, is returned.

Parameters:

e - Ticket exception to handle.

messageContext - the spring message context

Returns:

Name of next flow state to transition to or