Package net.shibboleth.sp.saml.saml2.profile.impl

Class ProcessLogoutTokenRequest

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.saml.saml2.profile.impl.ProcessLogoutTokenRequest

All Implemented Interfaces:

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

public class ProcessLogoutTokenRequest
extends AbstractApplicationAction

Processes a request to potentially issue a SAML 2.0 LogoutResponse by examining the input to recover the "token" issued by the logout-consumer flow in a previous call.

Assuming the token is present and sufficient, it creates a RelyingPartyContext based on the identity of the original IdP that needs to receive the message and a StateDataContext to store the state recovered from the token, principally the original request's ID and RelayState value.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.INVALID_MESSAGE, EventIds.INVALID_MSG_CTX, EventIds.UNABLE_TO_DECODE, IdPEventIds.INVALID_RELYING_PARTY_CTX

Precondition:

profileRequestContext.ensureSubcontext(AgentRequestContext.class).getInput().getmember("token").string() != null

Postcondition:

profileRequestContext.getSubcontext(StateDataContext.class) != null

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextCreationStrategy	Creation strategy for RelyingPartyContext.
private SAMLStateData	stateData	State data recovered from token.
private Function<ProfileRequestContext,StateDataContext>	stateDataContextCreationStrategy	Creation strategy for StateDataContext.
private StateManager	stateManager	Custom StateManager used to process the "token" parameter.

Constructor Summary

Constructors

Constructor	Description
ProcessLogoutTokenRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setRelyingPartyContextCreationStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set strategy to create the RelyingPartyContext.
void	setStateDataContextCreationStrategy(Function<ProfileRequestContext,StateDataContext> strategy)	Set strategy to create the StateDataContext.
void	setStateManager(StateManager manager)	Sets the StateManager to parse token parameter with.

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.

stateManager

@NonnullAfterInit
private StateManager stateManager

Custom StateManager used to process the "token" parameter.

stateDataContextCreationStrategy

@Nonnull
private Function<ProfileRequestContext,StateDataContext> stateDataContextCreationStrategy

Creation strategy for StateDataContext.

relyingPartyContextCreationStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextCreationStrategy

Creation strategy for RelyingPartyContext.

stateData

@NonnullBeforeExec
private SAMLStateData stateData

State data recovered from token.

Constructor Details

ProcessLogoutTokenRequest

public ProcessLogoutTokenRequest()

Constructor.

Method Details

setStateManager

public void setStateManager(@Nonnull
 StateManager manager)

Sets the StateManager to parse token parameter with.

Parameters:

manager - state manager

setStateDataContextCreationStrategy

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

Set strategy to create the StateDataContext.

Parameters:

strategy - creation strategy

setRelyingPartyContextCreationStrategy

public void setRelyingPartyContextCreationStrategy(@Nonnull
 Function<ProfileRequestContext,RelyingPartyContext> strategy)

Set strategy to create the RelyingPartyContext.

Parameters:

strategy - creation strategy

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