org.apereo.cas.web.flow

Class AuthenticationExceptionHandlerAction

java.lang.Object

org.springframework.webflow.action.AbstractAction

org.apereo.cas.web.flow.AuthenticationExceptionHandlerAction

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, org.springframework.webflow.execution.Action

public class AuthenticationExceptionHandlerAction
extends org.springframework.webflow.action.AbstractAction

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

Field Summary

Fields inherited from class org.springframework.webflow.action.AbstractAction

logger

Constructor Summary

Constructors

Constructor and Description
AuthenticationExceptionHandlerAction()
AuthenticationExceptionHandlerAction(java.util.Set<java.lang.Class<? extends java.lang.Exception>> errors)

Method Summary

Modifier and Type	Method and Description
protected org.springframework.webflow.execution.Event	doExecute(org.springframework.webflow.execution.RequestContext requestContext)
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.

Methods inherited from class org.springframework.webflow.action.AbstractAction

afterPropertiesSet, doPostExecute, doPreExecute, error, error, execute, getActionNameForLogging, getEventFactorySupport, initAction, no, result, result, result, result, success, success, yes

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationExceptionHandlerAction

public AuthenticationExceptionHandlerAction()

AuthenticationExceptionHandlerAction

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

Method Detail

getErrors

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

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

doExecute

protected org.springframework.webflow.execution.Event doExecute(org.springframework.webflow.execution.RequestContext requestContext)
                                                         throws java.lang.Exception

Specified by:

doExecute in class org.springframework.webflow.action.AbstractAction

Throws:

java.lang.Exception