Package org.opensaml.storage.impl.client

Class ClientStorageService

java.lang.Object

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

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

org.opensaml.storage.AbstractStorageService

org.opensaml.storage.AbstractMapBackedStorageService

org.opensaml.storage.impl.client.ClientStorageService

All Implemented Interfaces:

javax.servlet.Filter, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, StorageCapabilities, StorageCapabilitiesEx, StorageService

public class ClientStorageService
extends AbstractMapBackedStorageService
implements javax.servlet.Filter, StorageCapabilitiesEx

Implementation of StorageService that stores data in-memory in a shared session attribute.

The data for this service is managed in a ClientStorageService.ClientStorageServiceStore object, which must be created by some operation within the container for this implementation to function. Actual load/store of the data to/from that object is driven via companion classes. The serialization of data via JSON is inside the storage object class, but the encryption/decryption is here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ClientStorageService.ClientStorageServiceStore	Implements a session-bound backing store and locking mechanism for the ClientStorageService.
static class	ClientStorageService.ClientStorageSource	Enumeration of possible sources for the data.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<ClientStorageService.ClientStorageSource,Integer>	capabilityMap	Sizes to report for context, key, and value limits when particular sources are used.
private CookieManager	cookieManager	Manages creation of cookies.
private DataSealer	dataSealer	DataSealer instance to secure data.
private static String	DEFAULT_STORAGE_NAME	Default label for storage tracking.
private javax.servlet.http.HttpServletRequest	httpServletRequest	Servlet request.
private DataSealerKeyStrategy	keyStrategy	KeyStrategy enabling us to detect whether data has been sealed with an older key.
protected static String	LOCK_ATTRIBUTE	Name of session attribute for session lock.
private org.slf4j.Logger	log	Class logger.
protected static String	STORAGE_ATTRIBUTE	Name of session attribute for storage object.
private String	storageName	Label used to track storage.

Constructor Summary

Constructors

Constructor	Description
ClientStorageService()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
protected void	doInitialize()
protected TimerTask	getCleanupTask()
protected Map<String,Map<String,MutableStorageRecord<?>>>	getContextMap()
int	getContextSize()
CookieManager	getCookieManager()	Get the CookieManager to use.
int	getKeySize()
protected ReadWriteLock	getLock()
private String	getLogPrefix()	Get a prefix for log messages.
(package private) ClientStorageService.ClientStorageSource	getSource()	Get the backing source of the loaded data.
String	getStorageName()	Get the label to use for storage tracking.
long	getValueSize()
void	init(javax.servlet.FilterConfig filterConfig)
boolean	isClustered()
(package private) boolean	isLoaded()	Check whether data from the client has been loaded into the current session.
boolean	isServerSide()
(package private) void	load(String raw, ClientStorageService.ClientStorageSource source)	Reconstitute stored data and inject it into the session.
(package private) ClientStorageServiceOperation	save()	Serialize the stored data if it's in a "modified/dirty" state.
void	setCapabilityMap(Map<ClientStorageService.ClientStorageSource,Integer> map)	Set the map of storage sources to capability/size limits.
void	setCleanupInterval(Duration interval)
void	setCookieManager(CookieManager manager)	Set the CookieManager to use.
void	setDataSealer(DataSealer sealer)	Set the DataSealer to use for data security.
protected void	setDirty()
void	setHttpServletRequest(javax.servlet.http.HttpServletRequest request)	Set the servlet request in which to manage per-request data.
void	setKeyStrategy(DataSealerKeyStrategy strategy)	Set the DataSealerKeyStrategy to use for stale key detection.
void	setStorageName(String name)	Set the label to use for storage tracking.

Methods inherited from class org.opensaml.storage.AbstractMapBackedStorageService

create, delete, deleteContext, deleteImpl, deleteWithVersion, read, read, readImpl, reap, reapWithLock, update, updateContextExpiration, updateExpiration, updateImpl, updateWithVersion

Methods inherited from class org.opensaml.storage.AbstractStorageService

create, create, delete, deleteWithVersion, doDestroy, getCapabilities, getCleanupInterval, getCleanupTaskTimer, read, setCleanupTaskTimer, setContextSize, setKeySize, setValueSize, update, update, updateExpiration, updateWithVersion, updateWithVersion

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, 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 javax.servlet.Filter

destroy

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

LOCK_ATTRIBUTE

@Nonnull
protected static final String LOCK_ATTRIBUTE

Name of session attribute for session lock.

See Also:

Constant Field Values

STORAGE_ATTRIBUTE

@Nonnull
protected static final String STORAGE_ATTRIBUTE

Name of session attribute for storage object.

See Also:

Constant Field Values

DEFAULT_STORAGE_NAME

@Nonnull
@NotEmpty
private static final String DEFAULT_STORAGE_NAME

Default label for storage tracking.

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

capabilityMap

@Nonnull
@NotEmpty
private Map<ClientStorageService.ClientStorageSource,Integer> capabilityMap

Sizes to report for context, key, and value limits when particular sources are used.

httpServletRequest

@NonnullAfterInit
private javax.servlet.http.HttpServletRequest httpServletRequest

Servlet request.

cookieManager

@NonnullAfterInit
private CookieManager cookieManager

Manages creation of cookies.

storageName

@Nonnull
@NotEmpty
private String storageName

Label used to track storage.

dataSealer

@NonnullAfterInit
private DataSealer dataSealer

DataSealer instance to secure data.

keyStrategy

@Nullable
private DataSealerKeyStrategy keyStrategy

KeyStrategy enabling us to detect whether data has been sealed with an older key.

Constructor Detail

ClientStorageService

public ClientStorageService()

Constructor.

Method Detail

setCleanupInterval

public void setCleanupInterval(@Nullable
                               Duration interval)

Overrides:

setCleanupInterval in class AbstractStorageService

setCapabilityMap

public void setCapabilityMap(@Nonnull @NonnullElements
                             Map<ClientStorageService.ClientStorageSource,Integer> map)

Set the map of storage sources to capability/size limits.

The defaults include 4192 characters for cookies and 1024^2 characters for local storage.

Parameters:

map - capability map

isServerSide

public boolean isServerSide()

Specified by:

isServerSide in interface StorageCapabilitiesEx

isClustered

public boolean isClustered()

Specified by:

isClustered in interface StorageCapabilitiesEx

setHttpServletRequest

public void setHttpServletRequest(@Nonnull
                                  javax.servlet.http.HttpServletRequest request)

Set the servlet request in which to manage per-request data.

Parameters:

request - servlet request in which to manage data

getCookieManager

@NonnullAfterInit
public CookieManager getCookieManager()

Get the CookieManager to use.

Returns:

the CookieManager to use

setCookieManager

public void setCookieManager(@Nonnull
                             CookieManager manager)

Set the CookieManager to use.

Parameters:

manager - the CookieManager to use.

getStorageName

@Nonnull
@NotEmpty
public String getStorageName()

Get the label to use for storage tracking.

Returns:

label to use

setStorageName

public void setStorageName(@Nonnull @NotEmpty
                           String name)

Set the label to use for storage tracking.

Parameters:

name - label to use

setDataSealer

public void setDataSealer(@Nonnull
                          DataSealer sealer)

Set the DataSealer to use for data security.

Parameters:

sealer - DataSealer to use for data security

setKeyStrategy

public void setKeyStrategy(@Nullable
                           DataSealerKeyStrategy strategy)

Set the DataSealerKeyStrategy to use for stale key detection.

Parameters:

strategy - DataSealerKeyStrategy to use for stale key detection

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

getContextSize

public int getContextSize()

Specified by:

getContextSize in interface StorageCapabilities

Overrides:

getContextSize in class AbstractStorageService

getKeySize

public int getKeySize()

Specified by:

getKeySize in interface StorageCapabilities

Overrides:

getKeySize in class AbstractStorageService

getValueSize

public long getValueSize()

Specified by:

getValueSize in interface StorageCapabilities

Overrides:

getValueSize in class AbstractStorageService

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractStorageService

Throws:

ComponentInitializationException

getCleanupTask

@Nullable
protected TimerTask getCleanupTask()

Overrides:

getCleanupTask in class AbstractStorageService

getLock

@Nonnull
protected ReadWriteLock getLock()

Specified by:

getLock in class AbstractMapBackedStorageService

getContextMap

@Nonnull
@NonnullElements
@Live
protected Map<String,Map<String,MutableStorageRecord<?>>> getContextMap()
                                                                             throws IOException

Specified by:

getContextMap in class AbstractMapBackedStorageService

Throws:

IOException

setDirty

protected void setDirty()
                 throws IOException

Overrides:

setDirty in class AbstractMapBackedStorageService

Throws:

IOException

getSource

@Nonnull
ClientStorageService.ClientStorageSource getSource()
                                            throws IOException

Get the backing source of the loaded data.

This method should not be called while holding the session lock returned by getLock().

Returns:

the source of the loaded data

Throws:

IOException - to signal an error

isLoaded

boolean isLoaded()
          throws IOException

Check whether data from the client has been loaded into the current session.

This method should not be called while holding the session lock returned by getLock().

Returns:

true iff the HttpSession contains a storage object

Throws:

IOException - to signal an error

load

void load(@Nullable @NotEmpty
          String raw,
          @Nonnull
          ClientStorageService.ClientStorageSource source)

Reconstitute stored data and inject it into the session.

This method should not be called while holding the session lock returned by getLock().

Parameters:

raw - encrypted data to load as storage contents, or null if none

source - indicates source of the data for later use

save

@Nullable
ClientStorageServiceOperation save()

Serialize the stored data if it's in a "modified/dirty" state.

This method should not be called while holding the session lock returned by getLock().

Returns:

if dirty, the operation to perform, if not dirty, a null value

getLogPrefix

@Nonnull
@NotEmpty
private String getLogPrefix()

Get a prefix for log messages.

Returns:

logging prefix