net.shibboleth.idp.session.impl

Class UpdateSessionWithSPSession

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

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 UpdateSessionWithSPSession
extends net.shibboleth.idp.profile.AbstractProfileAction

An action that establishes a record of an SPSession in an existing IdPSession for the client.

The SPSession to add is obtained using a strategy function injected into the action, with a default that creates a standard implementation using information from the ProfileRequestContext.

The existing session to modify is identified via a SessionContext attached to the ProfileRequestContext.

An error interacting with the session layer will result in an EventIds.IO_ERROR event.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.IO_ERROR

Postcondition:

If ProfileRequestContext.getSubcontext(SessionContext.class, false).getIdPSession() != null and a non-null SPSession is supplied by the strategy function, then the steps above are performed.

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.
private SessionContext	sessionCtx Existing or newly created SessionContext.
private long	sessionLifetime Lifetime of sessions to create, if using the default strategy function.
private SessionManager	sessionManager SessionManager.
private com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,SPSession>	spSessionCreationStrategy A function that returns the SPSession to add.

Constructor Summary

Constructors

Constructor and Description
UpdateSessionWithSPSession()

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	setSessionLifetime(long lifetime) Set the default session lifetime to apply if using the default creation strategy for an SPSession.
void	setSessionManager(SessionManager manager) Set the SessionManager to use.
void	setSPSessionCreationStrategy(com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,SPSession> strategy) Set the creation function to use to obtain the SPSession to add.

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

log

@Nonnull
private final Logger log

Class logger.

sessionLifetime

@Positive
@Duration
private long sessionLifetime

Lifetime of sessions to create, if using the default strategy function.

spSessionCreationStrategy

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

A function that returns the SPSession to add.

sessionManager

@NonnullAfterInit
private SessionManager sessionManager

SessionManager.

sessionCtx

@Nullable
private SessionContext sessionCtx

Existing or newly created SessionContext.

Constructor Detail

UpdateSessionWithSPSession

public UpdateSessionWithSPSession()

Method Detail

setSessionLifetime

public void setSessionLifetime(@Positive@Duration
                      long lifetime)

Set the default session lifetime to apply if using the default creation strategy for an SPSession.

Only used if a strategy is not set.

Parameters:

lifetime - lifetime in milliseconds

setSPSessionCreationStrategy

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

Set the creation function to use to obtain the SPSession to add.

Parameters:

strategy - creation function to use

setSessionManager

public void setSessionManager(@Nonnull
                     SessionManager manager)

Set the SessionManager to use.

Parameters:

manager - session manager to use

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