org.opensaml.storage.impl.client

Class SaveCookieBackedClientStorageServices<InboundMessageType,OutboundMessageType>

java.lang.Object

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

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

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

Type Parameters:

InboundMessageType -

OutboundMessageType -

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction<InboundMessageType,OutboundMessageType>

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

An action that performs any number of ClientStorageServiceOperation instances sourced from cookies by issuing the necessary Set-Cookie headers.

The ClientStorageSaveContext is also removed.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX

Postcondition:

ProfileRequestContext.getSubcontext(ClientStorageSaveContext.class) == null

Field Summary

Fields

Modifier and Type	Field and Description
private ClientStorageSaveContext	clientStorageSaveCtx Context to drive storage save.
private com.google.common.escape.Escaper	escaper URL encoder.
private org.slf4j.Logger	log Class logger.
private Map<String,ClientStorageService>	storageServices The storage service instances to load, keyed by their bean ID.

Constructor Summary

Constructors

Constructor and Description
SaveCookieBackedClientStorageServices() 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

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

storageServices

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

The storage service instances to load, keyed by their bean ID.

clientStorageSaveCtx

@Nullable
private ClientStorageSaveContext clientStorageSaveCtx

Context to drive storage save.

escaper

@Nonnull
private com.google.common.escape.Escaper escaper

URL encoder.

Constructor Detail

SaveCookieBackedClientStorageServices

public SaveCookieBackedClientStorageServices()

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>