Package org.apereo.cas.web.flow.login

Class VerifyRequiredServiceAction

  • All Implemented Interfaces:
    org.springframework.beans.factory.InitializingBean, org.springframework.webflow.execution.Action
    public class VerifyRequiredServiceAction
extends org.springframework.webflow.action.AbstractAction
    Class to automatically set the paths for the CookieGenerators.

    Note: This is technically not thread-safe, but because its overriding with a constant value it doesn't matter.

    Note: As of CAS 3.1, this is a required class that retrieves and exposes the values in the two cookies for subclasses to use.

    Since:
    3.1

    • 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 java.util.List<org.apereo.cas.authentication.principal.Service> collectServicesToMatch​(org.springframework.webflow.execution.RequestContext context, java.lang.String ticketGrantingTicketId)
      Collect services to match.
      org.springframework.webflow.execution.Event doExecute​(org.springframework.webflow.execution.RequestContext context)  
      protected void enforceInitialMandatoryService​(org.springframework.webflow.execution.RequestContext context, java.lang.String ticketGrantingTicketId, java.util.regex.Pattern initialServicePattern)
      Configure webflow for initial mandatory service.
      protected boolean shouldSkipRequiredServiceCheck​(org.springframework.webflow.execution.RequestContext context, java.util.regex.Pattern initialServicePattern)
      Should skip required service check.

      • 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

      • VerifyRequiredServiceAction

        public VerifyRequiredServiceAction()

    • Method Detail

      • doExecute

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

      • enforceInitialMandatoryService

        protected void enforceInitialMandatoryService​(org.springframework.webflow.execution.RequestContext context,
                                              java.lang.String ticketGrantingTicketId,
                                              java.util.regex.Pattern initialServicePattern)
        Configure webflow for initial mandatory service.
        Parameters:
        context - the context
        ticketGrantingTicketId - the ticket granting ticket id
        initialServicePattern - the initial service pattern

      • shouldSkipRequiredServiceCheck

        protected boolean shouldSkipRequiredServiceCheck​(org.springframework.webflow.execution.RequestContext context,
                                                 java.util.regex.Pattern initialServicePattern)
        Should skip required service check.
        Parameters:
        context - the context
        initialServicePattern - the initial service pattern
        Returns:
        true/false

      • collectServicesToMatch

        protected java.util.List<org.apereo.cas.authentication.principal.Service> collectServicesToMatch​(org.springframework.webflow.execution.RequestContext context,
                                                                                                 java.lang.String ticketGrantingTicketId)
        Collect services to match.
        Parameters:
        context - the context
        ticketGrantingTicketId - the ticket granting ticket id
        Returns:
        the list