Package net.shibboleth.sp.profile.impl

Class RecoverStateData

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.profile.impl.RecoverStateData

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class RecoverStateData
extends AbstractApplicationAction

Action that maps a state token into a StateData (or subclass) object.

The state token comes from a pluggable function.

The token and the recovered object will be set into a StateDataContext created by a pluggable strategy.

Errors resulting from the absence of a state token or a failure to recover associated state may be ignored or result in an EventIds.IO_ERROR event. For example, if the protocol supports unsolicited requests, a failure to retrieve prior state may be expected and should be ignored.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.IO_ERROR

Precondition:

AgentRequestContext.getOutput().isstruct()

,

AgentRequestContext.getRemotedServletResponse() != null

Postcondition:

a StateDataContext is created and populated as directed

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RecoverStateData.DefaultStateTokenLookupStrategy	Default lookup strategy locates state token from Agent request.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	errorFatal	Whether any failure to recover previously stored state should result in a fatal event.
private final org.slf4j.Logger	log	Class logger.
private Class<? extends StateData>	stateDataClass	Specific class to be recovered.
private Function<ProfileRequestContext,StateDataContext>	stateDataContextCreationStrategy	Strategy used to create the StateDataContext to populate.
private String	stateToken	State token returned by lookup function.
private Function<ProfileRequestContext,String>	stateTokenLookupStrategy	Lookup strategy for state token.

Constructor Summary

Constructors

Constructor	Description
RecoverStateData()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setErrorFatal(boolean flag)	Sets whether any failure to recover previously stored state should result in a fatal event.
void	setStateDataClass(Class<? extends StateData> type)	Sets the type of StateData subclass to recover from the state token.
void	setStateDataContextCreationStrategy(Function<ProfileRequestContext,StateDataContext> strategy)	Sets the strategy used to create the StateDataContext.
void	setStateTokenLookupStrategy(Function<ProfileRequestContext,String> strategy)	Sets the lookup strategy to obtain the protocol specific state token.

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

stateDataContextCreationStrategy

@Nonnull
private Function<ProfileRequestContext,StateDataContext> stateDataContextCreationStrategy

Strategy used to create the StateDataContext to populate.

stateTokenLookupStrategy

@NonnullAfterInit
private Function<ProfileRequestContext,String> stateTokenLookupStrategy

Lookup strategy for state token.

errorFatal

private boolean errorFatal

Whether any failure to recover previously stored state should result in a fatal event.

stateDataClass

@Nonnull
private Class<? extends StateData> stateDataClass

Specific class to be recovered.

stateToken

@NonnullBeforeExec
private String stateToken

State token returned by lookup function.

Constructor Details

RecoverStateData

public RecoverStateData()

Constructor.

Method Details

setStateDataContextCreationStrategy

public void setStateDataContextCreationStrategy(@Nonnull
 Function<ProfileRequestContext,StateDataContext> strategy)

Sets the strategy used to create the StateDataContext.

Parameters:

strategy - creation strategy

setStateTokenLookupStrategy

public void setStateTokenLookupStrategy(@Nonnull
 Function<ProfileRequestContext,String> strategy)

Sets the lookup strategy to obtain the protocol specific state token.

Parameters:

strategy - lookup strategy

setErrorFatal

public void setErrorFatal(boolean flag)

Sets whether any failure to recover previously stored state should result in a fatal event.

Defaults to false.

Parameters:

flag - flag to set

setStateDataClass

public void setStateDataClass(@Nonnull
 Class<? extends StateData> type)

Sets the type of StateData subclass to recover from the state token.

Parameters:

type - subtype to recover

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractApplicationAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction