Package net.shibboleth.sp.profile

Class AbstractTokenConsumerResponseAction

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

All Implemented Interfaces:

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

public abstract class AbstractTokenConsumerResponseAction
extends AbstractApplicationAction

Base class for protocol-specific "token consumer" flow actions that prepare the response for the agent when completing processing.

This class operates on the principle that most of the output of a consumer flow consists of an AttributeContext containing the data making up the results together with opaque data that accompanies the results in order to allow the agent to store and return any protocol-specific data needed for subsequent operations, primarily logout.

Subclasses are responsible for carrying out certain tasks that will be protocol- specific, such as accessing protocol state needed to recover the original resource.

The agent response will generally contain an HTTP response structure capturing a redirect to the recovered URL, the serialized attribute data, and the opaque session data.

If the response is "committed" prior to this action, then the redirect portion will be skipped in favor of the previous response.

Event:

EventIds.PROCEED_EVENT_ID

Precondition:

AgentRequestContext.getOutput().isstruct()

,

AgentRequestContext.getRemotedServletResponse() != null

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,AttributeContext>	attributeContextLookupStrategy	Strategy used to locate AttributeContext with results.
private Function<ProfileRequestContext,IdentifierGenerationStrategy>	idGeneratorLookupStrategy	Strategy used to locate the IdentifierGenerationStrategy to use.
private org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,StateDataContext>	stateDataContextLookupStrategy	Strategy used to locate the StateDataContext to pull target from.

Constructor Summary

Constructors

Constructor	Description
AbstractTokenConsumerResponseAction()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
protected abstract DDF	getSessionData(ProfileRequestContext profileRequestContext)	Get the opaque session data that the agent should bind to any session it creates for later use.
protected Instant	getSessionNotOnOrAfter(ProfileRequestContext profileRequestContext)	Get a timestamp for the expiration of the session directed by the authentication token, if any.
void	setAttributeContextLookupStrategy(Function<ProfileRequestContext,AttributeContext> strategy)	Set the strategy used to locate the AttributeContext with the results.
void	setIdentifierGeneratorLookupStrategy(Function<ProfileRequestContext,IdentifierGenerationStrategy> strategy)	Set the strategy used to locate the IdentifierGenerationStrategy to use.
void	setStateDataContextLookupStrategy(Function<ProfileRequestContext,StateDataContext> strategy)	Sets the strategy used to lookup 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 org.slf4j.Logger log

Class logger.

attributeContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,AttributeContext> attributeContextLookupStrategy

Strategy used to locate AttributeContext with results.

stateDataContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,StateDataContext> stateDataContextLookupStrategy

Strategy used to locate the StateDataContext to pull target from.

idGeneratorLookupStrategy

@Nonnull
private Function<ProfileRequestContext,IdentifierGenerationStrategy> idGeneratorLookupStrategy

Strategy used to locate the IdentifierGenerationStrategy to use.

Constructor Details

AbstractTokenConsumerResponseAction

public AbstractTokenConsumerResponseAction()

Constructor.

Method Details

setAttributeContextLookupStrategy

public void setAttributeContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,AttributeContext> strategy)

Set the strategy used to locate the AttributeContext with the results.

Parameters:

strategy - lookup strategy

setStateDataContextLookupStrategy

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

Sets the strategy used to lookup the StateDataContext.

Parameters:

strategy - lookup strategy

setIdentifierGeneratorLookupStrategy

public void setIdentifierGeneratorLookupStrategy(@Nonnull
 Function<ProfileRequestContext,IdentifierGenerationStrategy> strategy)

Set the strategy used to locate the IdentifierGenerationStrategy to use.

Parameters:

strategy - lookup strategy

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractApplicationAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

getSessionData

@Nullable
protected abstract DDF getSessionData(@Nonnull
 ProfileRequestContext profileRequestContext)

Get the opaque session data that the agent should bind to any session it creates for later use.

Parameters:

profileRequestContext - profile request context

Returns:

opaque session data as a DDF node, or null if no session data is provided

getSessionNotOnOrAfter

@Nullable
protected Instant getSessionNotOnOrAfter(@Nonnull
 ProfileRequestContext profileRequestContext)

Get a timestamp for the expiration of the session directed by the authentication token, if any.

Parameters:

profileRequestContext - profile request context

Returns:

session expiration time or null