Package net.shibboleth.sp.oidc.profile.impl

Class AddClientAddressToStateAction

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
org.opensaml.profile.action.AbstractProfileAction
org.opensaml.profile.action.AbstractConditionalProfileAction
net.shibboleth.idp.profile.AbstractProfileAction
net.shibboleth.sp.profile.AbstractAgentRequestAction
net.shibboleth.sp.profile.AbstractAgentAction
net.shibboleth.sp.profile.AbstractApplicationAction
net.shibboleth.sp.oidc.profile.impl.AddClientAddressToStateAction
All Implemented Interfaces:
net.shibboleth.shared.component.Component, net.shibboleth.shared.component.DestructableComponent, net.shibboleth.shared.component.InitializableComponent, org.opensaml.profile.action.ProfileAction, Aware, MessageSource, MessageSourceAware, Action
public class AddClientAddressToStateAction extends net.shibboleth.sp.profile.AbstractApplicationAction
An action that adds, if enabled in profile config, the client address to State Data.

When disabled, the pre-execute step will return false and the reminder of the action will be skipped.

Event:
EventIds.INVALID_PROFILE_CTX, IdPEventIds.INVALID_PROFILE_CONFIG

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private net.shibboleth.sp.ddf.DDF
    input
    The stashed input DDF from the Agent.
    private final org.slf4j.Logger
    log
    Class logger.
    private net.shibboleth.oidc.profile.config.OIDCSSORelyingPartyConfiguration
    profileConfiguration
    Applicable stashed profile configuration.
    private net.shibboleth.sp.context.StateDataContext
    stateDataContext
    The stashed state data context.
    private Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.sp.context.StateDataContext>
    stateDataContextLookupStrategy
    Strategy used to locate the StateDataContext to populate.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AddClientAddressToStateAction()
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
    protected boolean
    doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
    void
    setStateDataContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.sp.context.StateDataContext> strategy)
    Sets the strategy used to create the StateDataContext.

    Methods inherited from class net.shibboleth.sp.profile.AbstractApplicationAction

    ensureApplication, getApplication

    Methods inherited from class net.shibboleth.sp.profile.AbstractAgentAction

    ensureAgent, getAgent

    Methods inherited from class net.shibboleth.sp.profile.AbstractAgentRequestAction

    ensureAgentRequestContext, getAgentRequestContext, setAgentRequestContextLookupStrategy

    Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

    doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, 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, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

    Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

    checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

    initialize, isInitialized

  • Field Details

    • log

      @Nonnull private final org.slf4j.Logger log
      Class logger.

    • stateDataContextLookupStrategy

      @Nonnull private Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.sp.context.StateDataContext> stateDataContextLookupStrategy
      Strategy used to locate the StateDataContext to populate.

    • profileConfiguration

      @NonnullBeforeExec private net.shibboleth.oidc.profile.config.OIDCSSORelyingPartyConfiguration profileConfiguration
      Applicable stashed profile configuration.

    • stateDataContext

      @NonnullBeforeExec private net.shibboleth.sp.context.StateDataContext stateDataContext
      The stashed state data context.

    • input

      @NonnullBeforeExec private net.shibboleth.sp.ddf.DDF input
      The stashed input DDF from the Agent.

  • Constructor Details

    • AddClientAddressToStateAction

      public AddClientAddressToStateAction()
      Constructor.

  • Method Details

    • setStateDataContextLookupStrategy

      public void setStateDataContextLookupStrategy(@Nonnull Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.sp.context.StateDataContext> strategy)
      Sets the strategy used to create the StateDataContext.
      Parameters:
      strategy - creation strategy

    • doPreExecute

      protected boolean doPreExecute(@Nonnull org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
      Overrides:
      doPreExecute in class net.shibboleth.sp.profile.AbstractApplicationAction

    • doExecute

      protected void doExecute(@Nonnull org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
      Overrides:
      doExecute in class org.opensaml.profile.action.AbstractProfileAction