Package org.apereo.cas.web.flow

Class AbstractConsentAction

java.lang.Object
org.springframework.webflow.action.AbstractAction
org.apereo.cas.web.flow.actions.BaseCasWebflowAction
org.apereo.cas.web.flow.AbstractConsentAction
All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean, org.springframework.webflow.execution.Action
Direct Known Subclasses:
CheckConsentRequiredAction, ConfirmConsentAction
public abstract class AbstractConsentAction extends org.apereo.cas.web.flow.actions.BaseCasWebflowAction
This is AbstractConsentAction.
Since:
5.2.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.springframework.context.ConfigurableApplicationContext
    applicationContext
    The application context.
    protected final org.apereo.cas.authentication.attribute.AttributeDefinitionStore
    attributeDefinitionStore
    The attribute definition store that might contain metadata about consentable attributes.
    protected final org.apereo.cas.authentication.AuthenticationServiceSelectionPlan
    authenticationRequestServiceSelectionStrategies
    Service selection strategies.
    protected final org.apereo.cas.configuration.CasConfigurationProperties
    casProperties
    CAS Settings.
    protected final org.apereo.cas.consent.ConsentEngine
    consentEngine
    The consent engine that handles calculations.
    protected final org.apereo.cas.services.ServicesManager
    servicesManager
    The services manager.

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

    logger

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractConsentAction()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.apereo.cas.services.RegisteredService
    getRegisteredServiceForConsent(org.springframework.webflow.execution.RequestContext requestContext, org.apereo.cas.authentication.principal.Service service)
    Gets registered service for consent.
    protected void
    prepareConsentableAttributes(Map<String,List<Object>> attributes, org.springframework.webflow.execution.RequestContext context)
    Prepare consentable attributes.
    protected void
    prepareConsentForRequestContext(org.springframework.webflow.execution.RequestContext requestContext)
    Prepare consent for request context.

    Methods inherited from class org.apereo.cas.web.flow.actions.BaseCasWebflowAction

    isLoginFlowActive

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

    afterPropertiesSet, doExecute, 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

  • Field Details

    • casProperties

      protected final org.apereo.cas.configuration.CasConfigurationProperties casProperties
      CAS Settings.

    • servicesManager

      protected final org.apereo.cas.services.ServicesManager servicesManager
      The services manager.

    • authenticationRequestServiceSelectionStrategies

      protected final org.apereo.cas.authentication.AuthenticationServiceSelectionPlan authenticationRequestServiceSelectionStrategies
      Service selection strategies.

    • consentEngine

      protected final org.apereo.cas.consent.ConsentEngine consentEngine
      The consent engine that handles calculations.

    • attributeDefinitionStore

      protected final org.apereo.cas.authentication.attribute.AttributeDefinitionStore attributeDefinitionStore
      The attribute definition store that might contain metadata about consentable attributes.

    • applicationContext

      protected final org.springframework.context.ConfigurableApplicationContext applicationContext
      The application context.

  • Constructor Details

    • AbstractConsentAction

      public AbstractConsentAction()

  • Method Details

    • getRegisteredServiceForConsent

      protected org.apereo.cas.services.RegisteredService getRegisteredServiceForConsent(org.springframework.webflow.execution.RequestContext requestContext, org.apereo.cas.authentication.principal.Service service)
      Gets registered service for consent.
      Parameters:
      requestContext - the request context
      service - the service
      Returns:
      the registered service for consent

    • prepareConsentForRequestContext

      protected void prepareConsentForRequestContext(org.springframework.webflow.execution.RequestContext requestContext)
      Prepare consent for request context. The original service is kept, and the resolved service is added to the flash-scope only to ensure consent works for all other callback services that deal with different protocols.
      Parameters:
      requestContext - the request context

    • prepareConsentableAttributes

      protected void prepareConsentableAttributes(Map<String,List<Object>> attributes, org.springframework.webflow.execution.RequestContext context)
      Prepare consentable attributes.
      Parameters:
      attributes - the attributes
      context - the context