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

Class ProcessLogoutInitiatorRequest

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

All Implemented Interfaces:

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

public class ProcessLogoutInitiatorRequest
extends AbstractApplicationAction

Processes a request to potentially initiate a SAML 2.0 logout by examining the input to recover the required information from the opaque portion of the session created by the token consumer flow and store in a newly created SAMLLogoutContext.

Assuming the opaque data is present and sufficient, it also creates a RelyingPartyContext based on the identity of the original IdP that issued the token that led to the session.

Event:

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

Postcondition:

profileRequestContext.getSubcontext(SAMLLogoutContext.class) != null

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private NameID	nameID	NameID from session.
private ParserPool	parserPool	Parser machinery.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextCreationStrategy	Creation strategy for RelyingPartyContext.
private String	relyingPartyId	The relying party name to base the inbound context on.
private String	sessionIndex	Session index from session.

Constructor Summary

Constructors

Constructor	Description
ProcessLogoutInitiatorRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setParserPool(ParserPool pool)	Sets the ParserPool to parse session data with.
void	setRelyingPartyContextCreationStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set strategy to create the RelyingPartyContext.

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.

parserPool

@NonnullAfterInit
private ParserPool parserPool

Parser machinery.

relyingPartyContextCreationStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextCreationStrategy

Creation strategy for RelyingPartyContext.

relyingPartyId

@NonnullBeforeExec
private String relyingPartyId

The relying party name to base the inbound context on.

nameID

@NonnullBeforeExec
private NameID nameID

NameID from session.

sessionIndex

@Nullable
private String sessionIndex

Session index from session.

Constructor Details

ProcessLogoutInitiatorRequest

public ProcessLogoutInitiatorRequest()

Constructor.

Method Details

setParserPool

public void setParserPool(@Nonnull
 ParserPool pool)

Sets the ParserPool to parse session data with.

Parameters:

pool - parser pool

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