org.opensaml.storage.impl

Class ServletRequestScopedStorageService

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.ServletRequestScopedStorageService

All Implemented Interfaces:

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

public class ServletRequestScopedStorageService
extends AbstractMapBackedStorageService
implements RequestScopedStorageService, javax.servlet.Filter, StorageCapabilitiesEx

Implementation of RequestScopedStorageService that stores data in-memory in a servlet request attribute, and reads and writes the data with a secured string form using JSON as the underlying format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ServletRequestScopedStorageService.DummyReadWriteLock Dummy shared lock that no-ops.
private class	ServletRequestScopedStorageService.OutputInterceptingHttpServletResponseProxy An implementation of HttpServletResponse which detects a response going out from a servlet and executes a save operation.

Field Summary

Fields

Modifier and Type	Field and Description
private int	capabilitySize Size to report for context, key, and value limits.
protected static String	CONTEXT_MAP_ATTRIBUTE Name of request attribute for context map.
private CookieManager	cookieManager Manages creation of cookies.
private String	cookieName Name of cookie used to track storage.
private DataSealer	dataSealer DataSealer instance to secure data.
private static String	DEFAULT_COOKIE_NAME Default cookie name for storage tracking.
protected static String	DIRTY_BIT_ATTRIBUTE Name of request attribute used as a dirty bit.
private static ReadWriteLock	DUMMY_LOCK A dummy lock implementation.
private com.google.common.escape.Escaper	escaper URL encoder.
private javax.servlet.http.HttpServletRequest	httpServletRequest Servlet request.
private javax.servlet.http.HttpServletResponse	httpServletResponse Servlet response.
private DataSealerKeyStrategy	keyStrategy KeyStrategy enabling us to detect whether data has been sealed with an older key.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
ServletRequestScopedStorageService() Constructor.

Method Summary

Methods

Modifier and Type	Method and 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()
String	getCookieName() Get the cookie name to use for storage tracking.
protected ReadWriteLock	getLock()
void	init(javax.servlet.FilterConfig filterConfig)
boolean	isClustered()
private boolean	isDirty() Get the dirty bit for the current request.
boolean	isServerSide()
protected void	load() Reconstitute stored data.
protected void	save() Write/preserve stored data for subsequent requests.
void	setCapabilitySize(int size) Set the size to report via the StorageCapabilities interface for context, key, and value maximums.
void	setCleanupInterval(long interval)
void	setCookieManager(CookieManager manager) Set the CookieManager to use.
void	setCookieName(String name) Set the cookie name to use for storage tracking.
void	setDataSealer(DataSealer sealer) Set the DataSealer to use for data security.
void	setDirty()
private void	setDirty(boolean flag) Set the dirty bit for the current request.
void	setHttpServletRequest(javax.servlet.http.HttpServletRequest request) Set the servlet request in which to manage per-request data.
void	setHttpServletResponse(javax.servlet.http.HttpServletResponse response) Set the servlet response in which to manage per-request data.
void	setKeyStrategy(DataSealerKeyStrategy strategy) Set the DataSealerKeyStrategy to use for stale key detection.
protected Long	updateImpl(Long version, String context, String key, String value, Long expiration)

Methods inherited from class org.opensaml.storage.AbstractMapBackedStorageService

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

Methods inherited from class org.opensaml.storage.AbstractStorageService

create, create, delete, deleteWithVersion, doDestroy, getCapabilities, getCleanupInterval, getCleanupTaskTimer, getContextSize, getKeySize, getValueSize, 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 org.opensaml.storage.StorageService

create, create, create, delete, delete, deleteContext, deleteWithVersion, deleteWithVersion, getCapabilities, read, read, read, reap, update, update, update, updateContextExpiration, updateExpiration, updateExpiration, updateWithVersion, updateWithVersion, updateWithVersion

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

getId

Methods inherited from interface javax.servlet.Filter

destroy

Methods inherited from interface org.opensaml.storage.StorageCapabilities

getContextSize, getKeySize, getValueSize

Field Detail

CONTEXT_MAP_ATTRIBUTE

@Nonnull
protected static final String CONTEXT_MAP_ATTRIBUTE

Name of request attribute for context map.

See Also:

Constant Field Values

DIRTY_BIT_ATTRIBUTE

@Nonnull
protected static final String DIRTY_BIT_ATTRIBUTE

Name of request attribute used as a dirty bit.

See Also:

Constant Field Values

DEFAULT_COOKIE_NAME

@Nonnull
@NotEmpty
private static final String DEFAULT_COOKIE_NAME

Default cookie name for storage tracking.

See Also:

Constant Field Values

DUMMY_LOCK

@Nonnull
private static final ReadWriteLock DUMMY_LOCK

A dummy lock implementation.

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

capabilitySize

private int capabilitySize

Size to report for context, key, and value limits.

httpServletRequest

@NonnullAfterInit
private javax.servlet.http.HttpServletRequest httpServletRequest

Servlet request.

httpServletResponse

@NonnullAfterInit
private javax.servlet.http.HttpServletResponse httpServletResponse

Servlet response.

cookieManager

@NonnullAfterInit
private CookieManager cookieManager

Manages creation of cookies.

cookieName

@Nonnull
@NotEmpty
private String cookieName

Name of cookie 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.

escaper

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

URL encoder.

Constructor Detail

ServletRequestScopedStorageService

public ServletRequestScopedStorageService()

Constructor.

Method Detail

setCleanupInterval

public void setCleanupInterval(long interval)

Overrides:

setCleanupInterval in class AbstractStorageService

setCapabilitySize

public void setCapabilitySize(int size)

Set the size to report via the StorageCapabilities interface for context, key, and value maximums.

Defaults to 4096 to reflect the limitations of cookies on Safari.

Parameters:

size - size in characters to report

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

setHttpServletResponse

public void setHttpServletResponse(@Nonnull
                          javax.servlet.http.HttpServletResponse response)

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

Parameters:

response - servlet response in which to manage data

setCookieManager

public void setCookieManager(@Nonnull
                    CookieManager manager)

Set the CookieManager to use.

Parameters:

manager - the CookieManager to use.

getCookieName

@Nonnull
@NotEmpty
public String getCookieName()

Get the cookie name to use for storage tracking.

Returns:

cookie name to use

setCookieName

public void setCookieName(@Nonnull@NotEmpty
                 String name)

Set the cookie name to use for storage tracking.

Parameters:

name - cookie name 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(@Nonnull
                  DataSealerKeyStrategy strategy)

Set the DataSealerKeyStrategy to use for stale key detection.

Parameters:

strategy - DataSealerKeyStrategy to use for stale key detection

isServerSide

public boolean isServerSide()

Specified by:

isServerSide in interface StorageCapabilitiesEx

isClustered

public boolean isClustered()

Specified by:

isClustered in interface StorageCapabilitiesEx

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractStorageService

Throws:

ComponentInitializationException

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

load

protected void load()
             throws IOException

Reconstitute stored data.

Throws:

IOException - if an error occurs reconstituting the data

save

@Nullable
protected void save()
             throws IOException

Write/preserve stored data for subsequent requests.

Throws:

IOException - if an error occurs preserving the data

updateImpl

@Nullable
protected Long updateImpl(@Nullable
                       Long version,
                       @Nonnull@NotEmpty
                       String context,
                       @Nonnull@NotEmpty
                       String key,
                       @Nullable
                       String value,
                       @Nullable
                       Long expiration)
                   throws IOException,
                          VersionMismatchException

Overrides:

updateImpl in class AbstractMapBackedStorageService

Throws:

IOException

VersionMismatchException

getCleanupTask

@Nullable
protected TimerTask getCleanupTask()

Overrides:

getCleanupTask in class AbstractStorageService

getContextMap

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

Specified by:

getContextMap in class AbstractMapBackedStorageService

getLock

@Nonnull
protected ReadWriteLock getLock()

Specified by:

getLock in class AbstractMapBackedStorageService

setDirty

public void setDirty()

Overrides:

setDirty in class AbstractMapBackedStorageService

setDirty

private void setDirty(boolean flag)

Set the dirty bit for the current request.

Parameters:

flag - dirty bit to set

isDirty

private boolean isDirty()

Get the dirty bit for the current request.

Returns:

status of dirty bit