Class ExtractConsent

  • All Implemented Interfaces:
    net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.profile.action.ProfileAction, Aware, MessageSource, MessageSourceAware, Action

    public class ExtractConsent
    extends AbstractConsentAction
    Consent action which extracts user input and updates current consent objects in the consent context accordingly. For every consent id passed via the CONSENT_IDS_REQUEST_PARAMETER request parameter, this action sets Consent.isApproved() to true for the current consent object whose id matches the request parameter value. For every current consent object whose id is not passed as a request parameter, this action sets Consent.isApproved() to false.
    Event:
    EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX
    Postcondition:
    See above.
    • Constructor Summary

      Constructors 
      Constructor Description
      ExtractConsent()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void doExecute​(org.opensaml.profile.context.ProfileRequestContext profileRequestContext, net.shibboleth.idp.profile.context.ProfileInterceptorContext interceptorContext)
      • Methods inherited from class net.shibboleth.idp.profile.interceptor.AbstractProfileInterceptorAction

        doExecute, doPreExecute, setLookupStrategy
      • Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

        doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy
      • Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

        getActivationCondition, setActivationCondition
      • Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

        doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse
      • Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

        destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized
      • Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

        initialize, isInitialized
    • Field Detail

      • CONSENT_IDS_REQUEST_PARAMETER

        @Nonnull
        @NotEmpty
        public static final String CONSENT_IDS_REQUEST_PARAMETER
        Parameter name for consent IDs.
        See Also:
        Constant Field Values
      • log

        @Nonnull
        private final Logger log
        Class logger.
    • Constructor Detail

      • ExtractConsent

        public ExtractConsent()
    • Method Detail

      • doExecute

        protected void doExecute​(@Nonnull
                                 org.opensaml.profile.context.ProfileRequestContext profileRequestContext,
                                 @Nonnull
                                 net.shibboleth.idp.profile.context.ProfileInterceptorContext interceptorContext)
        Overrides:
        doExecute in class net.shibboleth.idp.profile.interceptor.AbstractProfileInterceptorAction