org.opensaml.storage.impl.client

Class LoadClientStorageServices<InboundMessageType,OutboundMessageType>

java.lang.Object

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

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

org.opensaml.storage.impl.client.LoadClientStorageServices<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 LoadClientStorageServices<InboundMessageType,OutboundMessageType>
extends AbstractProfileAction<InboundMessageType,OutboundMessageType>

An action that loads any number of ClientStorageService instances from a POST submission or cookies as applicable.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX

Field Summary

Fields

Modifier and Type	Field and Description
private ClientStorageLoadContext	clientStorageLoadCtx Context to drive storage load.
static String	EXCEPTION_FORM_FIELD Name of local storage form field containing value read.
private Logger	log Class logger.
private Map<String,ClientStorageService>	storageServices The storage service instances to load.
static String	SUCCESS_FORM_FIELD Name of local storage form field signaling success/failure of a read operation.
static String	SUPPORT_FORM_FIELD Name of local storage form field containing local storage support indicator.
private boolean	useLocalStorage Whether to allow for data loaded from local storage and submitted via POST.
static String	VALUE_FORM_FIELD Name of local storage form field containing value read.

Constructor Summary

Constructors

Constructor and Description
LoadClientStorageServices() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)
private void	loadFromCookie(ClientStorageService storageService, ClientStorageService.ClientStorageSource source) Load the specified storage service from a cookie.
private void	loadFromLocalStorage(ClientStorageService storageService) Load the specified storage service from local storage data supplied in the POST.
void	setStorageServices(Collection<ClientStorageService> services) Set the ClientStorageService instances to check for loading.
void	setUseLocalStorage(boolean flag) Set whether to allow for data loaded from local storage and submitted via POST.

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

SUPPORT_FORM_FIELD

@Nonnull
@NotEmpty
public static final String SUPPORT_FORM_FIELD

Name of local storage form field containing local storage support indicator.

See Also:

Constant Field Values

SUCCESS_FORM_FIELD

@Nonnull
@NotEmpty
public static final String SUCCESS_FORM_FIELD

Name of local storage form field signaling success/failure of a read operation.

See Also:

Constant Field Values

VALUE_FORM_FIELD

@Nonnull
@NotEmpty
public static final String VALUE_FORM_FIELD

Name of local storage form field containing value read.

See Also:

Constant Field Values

EXCEPTION_FORM_FIELD

@Nonnull
@NotEmpty
public static final String EXCEPTION_FORM_FIELD

Name of local storage form field containing value read.

See Also:

Constant Field Values

log

@Nonnull
private final Logger log

Class logger.

useLocalStorage

private boolean useLocalStorage

Whether to allow for data loaded from local storage and submitted via POST.

storageServices

@Nonnull
@NonnullElements
private Map<String,ClientStorageService> storageServices

The storage service instances to load.

clientStorageLoadCtx

@Nullable
private ClientStorageLoadContext clientStorageLoadCtx

Context to drive storage load.

Constructor Detail

LoadClientStorageServices

public LoadClientStorageServices()

Constructor.

Method Detail

setUseLocalStorage

public void setUseLocalStorage(boolean flag)

Set whether to allow for data loaded from local storage and submitted via POST.

Parameters:

flag - flag to set

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>

loadFromCookie

private void loadFromCookie(@Nonnull
                  ClientStorageService storageService,
                  @Nonnull
                  ClientStorageService.ClientStorageSource source)

Load the specified storage service from a cookie.

Parameters:

storageService - service to load

source - source to apply to load operation

loadFromLocalStorage

private void loadFromLocalStorage(@Nonnull
                        ClientStorageService storageService)

Load the specified storage service from local storage data supplied in the POST.

Parameters:

storageService - service to load