Package org.apereo.cas.web.flow.actions

Class 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. 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.springframework.webflow.execution.Event doExecute​(org.springframework.webflow.execution.RequestContext requestContext)  
      java.lang.String handle​(java.lang.Exception e, org.springframework.webflow.execution.RequestContext requestContext)
      Maps an authentication exception onto a state name.

      • 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()

    • Method Detail

      • doExecute

        protected org.springframework.webflow.execution.Event doExecute​(org.springframework.webflow.execution.RequestContext requestContext)
        Specified by:
        doExecute in class org.springframework.webflow.action.AbstractAction

      • handle

        public java.lang.String handle​(java.lang.Exception e,
                               org.springframework.webflow.execution.RequestContext requestContext)
        Maps an authentication exception onto a state name. Also sets an ERROR severity message in the message context.
        Parameters:
        e - Authentication error to handle.
        requestContext - the spring context
        Returns:
        Name of next flow state to transition to or "UNKNOWN"