Package net.shibboleth.sp.profile.impl

Class DoSessionCacheOperation

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.impl.DoSessionCacheOperation

All Implemented Interfaces:

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

public class DoSessionCacheOperation
extends AbstractAgentAction

Action that implements a remote API for SP agents to mamage sessions remotely.

This is implememnted internally with a StorageService but implements the operations somewhat more efficiently with more awareness of the purpose.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.INVALID_MESSAGE, EventIds.IO_ERROR, EventIds.UNABLE_TO_DECODE, EventIds.UNABLE_TO_ENCODE, EventIds.MESSAGE_PROC_ERROR, INVALID_SESSION, MISSING_SESSION, EXPIRED_SESSION, VERSION_MISMATCH

Precondition:

AgentRequestContext.getOutput().isstruct()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXPIRED_SESSION	Custom event for expired session.
private IdentifierGenerationStrategy	identifierStrategy	Identifier generation.
private DDF	input	Input message.
static final String	INVALID_SESSION	Custom event for invalid session.
static final String	KEY	Input member for session key.
private org.slf4j.Logger	log	Class logger.
private Duration	maxStorageTimeout	Upper bound on agent-supplied storage timeout.
static final String	MISSING_SESSION	Custom event for invalid session.
static final String	OP	Input member for operation.
private DDF	output	Output message.
static final String	SESSION	Input member for session data.
static final String	STORAGE_CONTEXT	Storage context for sessions.
static final String	STORAGE_TIMEOUT	Member for session timeout.
private StorageService	storageService	StorageService to operate on.
static final String	TIMEOUT	Member for session timeout.
static final String	VERSION	Member for session version.
static final String	VERSION_MISMATCH	Custom event for version mismatch on conditional update.

Constructor Summary

Constructors

Constructor	Description
DoSessionCacheOperation()	Constructor.

Method Summary

Modifier and Type	Method	Description
private void	doCreate(ProfileRequestContext profileRequestContext)	Perform create operation.
private void	doDelete(ProfileRequestContext profileRequestContext)	Perform delete operation.
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
private void	doRead(ProfileRequestContext profileRequestContext)	Perform read operation.
private void	doTouch(ProfileRequestContext profileRequestContext)	Perform touch operation to update expiration (and thus time of last access).
private void	doUpdate(ProfileRequestContext profileRequestContext)	Perform update operation.
private String	getStorageContext()	Compute agent-specific storage context.
private Long	getStorageTimeout()	Get Agent-supplied storage timeout in seconds, bounded by configured maximum.
void	setIdentifierGenerationStrategy(IdentifierGenerationStrategy strategy)	Set IdentifierGenerationStrategy to use.
void	setMaxStorageTimeout(Duration timeout)	Sets the maximum storage life for session records that an Agent may request.
void	setStorageService(StorageService storage)	Sets the StorageService to use.

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

STORAGE_CONTEXT

@Nonnull
@NotEmpty
public static final String STORAGE_CONTEXT

Storage context for sessions.

See Also:

• Constant Field Values

INVALID_SESSION

@Nonnull
@NotEmpty
public static final String INVALID_SESSION

Custom event for invalid session.

See Also:

• Constant Field Values

MISSING_SESSION

@Nonnull
@NotEmpty
public static final String MISSING_SESSION

Custom event for invalid session.

See Also:

• Constant Field Values

EXPIRED_SESSION

@Nonnull
@NotEmpty
public static final String EXPIRED_SESSION

Custom event for expired session.

See Also:

• Constant Field Values

VERSION_MISMATCH

@Nonnull
@NotEmpty
public static final String VERSION_MISMATCH

Custom event for version mismatch on conditional update.

See Also:

• Constant Field Values

OP

@Nonnull
@NotEmpty
public static final String OP

Input member for operation.

See Also:

• Constant Field Values

SESSION

@Nonnull
@NotEmpty
public static final String SESSION

Input member for session data.

See Also:

• Constant Field Values

STORAGE_TIMEOUT

@Nonnull
@NotEmpty
public static final String STORAGE_TIMEOUT

Member for session timeout.

See Also:

• Constant Field Values

KEY

@Nonnull
@NotEmpty
public static final String KEY

Input member for session key.

See Also:

• Constant Field Values

TIMEOUT

@Nonnull
@NotEmpty
public static final String TIMEOUT

Member for session timeout.

See Also:

• Constant Field Values

VERSION

@Nonnull
@NotEmpty
public static final String VERSION

Member for session version.

See Also:

• Constant Field Values

log

@Nonnull
private org.slf4j.Logger log

Class logger.

storageService

@NonnullAfterInit
private StorageService storageService

StorageService to operate on.

identifierStrategy

@NonnullAfterInit
private IdentifierGenerationStrategy identifierStrategy

Identifier generation.

maxStorageTimeout

@Nonnull
private Duration maxStorageTimeout

Upper bound on agent-supplied storage timeout.

input

@NonnullBeforeExec
private DDF input

Input message.

output

@NonnullBeforeExec
private DDF output

Output message.

Constructor Details

DoSessionCacheOperation

public DoSessionCacheOperation()

Constructor.

Method Details

setStorageService

public void setStorageService(@Nonnull
 StorageService storage)

Sets the StorageService to use.

Parameters:

storage - storage service

setIdentifierGenerationStrategy

public void setIdentifierGenerationStrategy(@Nonnull
 IdentifierGenerationStrategy strategy)

Set IdentifierGenerationStrategy to use.

Defaults to a secure random source that produces 16 byte values.

Parameters:

strategy - identifier generator strategy

setMaxStorageTimeout

public void setMaxStorageTimeout(@Nonnull @Positive
 Duration timeout)

Sets the maximum storage life for session records that an Agent may request.

Defaults to 1 day.

Parameters:

timeout - maximum storage lifetime

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractAgentAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

doCreate

private void doCreate(@Nonnull
 ProfileRequestContext profileRequestContext)
               throws IOException

Perform create operation.

Parameters:

profileRequestContext - profile request context

Throws:

IOException - if an error is raised

doRead

private void doRead(@Nonnull
 ProfileRequestContext profileRequestContext)
             throws IOException

Perform read operation.

Parameters:

profileRequestContext - profile request context

Throws:

IOException - if an error is raised

doUpdate

private void doUpdate(@Nonnull
 ProfileRequestContext profileRequestContext)
               throws IOException

Perform update operation.

Parameters:

profileRequestContext - profile request context

Throws:

IOException - if an error is raised

doTouch

private void doTouch(@Nonnull
 ProfileRequestContext profileRequestContext)
              throws IOException

Perform touch operation to update expiration (and thus time of last access).

Parameters:

profileRequestContext - profile request context

Throws:

IOException - if an error is raised

doDelete

private void doDelete(@Nonnull
 ProfileRequestContext profileRequestContext)
               throws IOException

Perform delete operation.

Parameters:

profileRequestContext - profile request context

Throws:

IOException - if an error is raised

getStorageTimeout

@Nonnull
private Long getStorageTimeout()

Get Agent-supplied storage timeout in seconds, bounded by configured maximum.

Returns:

effective timeout in seconds

getStorageContext

@Nonnull
private String getStorageContext()

Compute agent-specific storage context.

Returns:

storage context with agent qualifier