net.shibboleth.idp.session.impl

Class PopulateLogoutContextForPropagation

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction<InboundMessageType,OutboundMessageType>

org.opensaml.profile.action.AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.session.impl.PopulateLogoutContextForPropagation

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.profile.action.ProfileAction, Aware, MessageSource, MessageSourceAware, org.springframework.webflow.execution.Action

public class PopulateLogoutContextForPropagation
extends net.shibboleth.idp.profile.AbstractProfileAction

Profile action that reconstitutes an encrypted SPSession object from an HTTP request parameter, and attaches it to a LogoutContext created with a strategy function.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.UNABLE_TO_DECODE

Postcondition:

If an SPSession is found and successfully deserialized, then a LogoutContext will be populated.

Field Summary

Fields

Modifier and Type	Field and Description
private net.shibboleth.utilities.java.support.security.DataSealer	dataSealer DataSealer to use.
private Logger	log Class logger.
private com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,LogoutContext>	logoutContextCreationStrategy Creation/lookup function for LogoutContext.
private SPSession	session SPSession to operate on.
private static String	SPSESSION_PARAM Name of parameter containing session.
private SPSessionSerializerRegistry	spSessionSerializerRegistry Mappings between a SPSession type and a serializer implementation.

Constructor Summary

Constructors

Constructor and Description
PopulateLogoutContextForPropagation() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
void	setDataSealer(net.shibboleth.utilities.java.support.security.DataSealer sealer) Set the DataSealer to use.
void	setLogoutContextCreationStrategy(com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,LogoutContext> strategy) Set the creation/lookup strategy for the LogoutContext to populate.
void	setSPSessionSerializerRegistry(SPSessionSerializerRegistry registry) Set the SPSessionSerializerRegistry to use.

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

doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, 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, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, 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.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

SPSESSION_PARAM

@Nonnull
@NotEmpty
private static final String SPSESSION_PARAM

Name of parameter containing session.

See Also:

Constant Field Values

log

@Nonnull
private final Logger log

Class logger.

dataSealer

@NonnullAfterInit
private net.shibboleth.utilities.java.support.security.DataSealer dataSealer

DataSealer to use.

spSessionSerializerRegistry

@NonnullAfterInit
private SPSessionSerializerRegistry spSessionSerializerRegistry

Mappings between a SPSession type and a serializer implementation.

logoutContextCreationStrategy

@Nonnull
private com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,LogoutContext> logoutContextCreationStrategy

Creation/lookup function for LogoutContext.

session

@Nullable
private SPSession session

SPSession to operate on.

Constructor Detail

PopulateLogoutContextForPropagation

public PopulateLogoutContextForPropagation()

Constructor.

Method Detail

setDataSealer

public void setDataSealer(@Nonnull
                 net.shibboleth.utilities.java.support.security.DataSealer sealer)

Set the DataSealer to use.

Parameters:

sealer - the DataSealer to use

setSPSessionSerializerRegistry

public void setSPSessionSerializerRegistry(@Nonnull
                                  SPSessionSerializerRegistry registry)

Set the SPSessionSerializerRegistry to use.

Parameters:

registry - a registry of SPSession class to serializer mappings

setLogoutContextCreationStrategy

public void setLogoutContextCreationStrategy(@Nonnull
                                    com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,LogoutContext> strategy)

Set the creation/lookup strategy for the LogoutContext to populate.

Parameters:

strategy - creation/lookup strategy

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
                   org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class org.opensaml.profile.action.AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
             org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class org.opensaml.profile.action.AbstractProfileAction