org.opensaml.storage.impl.client

Class PopulateClientStorageLoadContext<InboundMessageType,OutboundMessageType>

java.lang.Object

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

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

org.opensaml.storage.impl.client.PopulateClientStorageLoadContext<InboundMessageType,OutboundMessageType>

Type Parameters:

InboundMessageType -

OutboundMessageType -

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, ProfileAction<InboundMessageType,OutboundMessageType>

public class PopulateClientStorageLoadContext<InboundMessageType,OutboundMessageType>
extends AbstractProfileAction<InboundMessageType,OutboundMessageType>

An action that creates and populates a ClientStorageLoadContext with any storage keys identified as missing from the current session and in need of loading.

The action will signal the LOAD_NOT_NEEDED event if it is unnecessary to proceed with the load operation.

Event:

EventIds.PROCEED_EVENT_ID, LOAD_NOT_NEEDED

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOAD_NOT_NEEDED Event signaling that no load step is necessary.
private Logger	log Class logger.
private Collection<ClientStorageService>	storageServices The storage service instances to check for a loading requirement.

Constructor Summary

Constructors

Constructor and Description
PopulateClientStorageLoadContext() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)
void	setStorageServices(Collection<ClientStorageService> services) Set the ClientStorageService instances to check for loading.

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, doInitialize, 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

LOAD_NOT_NEEDED

@Nonnull
@NotEmpty
public static final String LOAD_NOT_NEEDED

Event signaling that no load step is necessary.

See Also:

Constant Field Values

log

@Nonnull
private final Logger log

Class logger.

storageServices

@Nonnull
@NonnullElements
private Collection<ClientStorageService> storageServices

The storage service instances to check for a loading requirement.

Constructor Detail

PopulateClientStorageLoadContext

public PopulateClientStorageLoadContext()

Constructor.

Method Detail

setStorageServices

public void setStorageServices(@Nonnull@NonnullElements
                      Collection<ClientStorageService> services)

Set the ClientStorageService instances to check for loading.

Parameters:

services - instances to check for loading

doPreExecute

protected boolean doPreExecute(@Nonnull
                   ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)

Overrides:

doPreExecute in class AbstractProfileAction<InboundMessageType,OutboundMessageType>

doExecute

protected void doExecute(@Nonnull
             ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction<InboundMessageType,OutboundMessageType>