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, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, RequestScopedStorageService, StorageCapabilities, StorageService

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

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
protected static java.lang.String	CONTEXT_MAP_ATTRIBUTE Name of request attribute for context map.
private net.shibboleth.utilities.java.support.net.CookieManager	cookieManager Manages creation of cookies.
private java.lang.String	cookieName Name of cookie used to track storage.
private net.shibboleth.utilities.java.support.security.DataSealer	dataSealer DataSealer instance to secure data.
private static java.lang.String	DEFAULT_COOKIE_NAME Default cookie name for storage tracking.
protected static java.lang.String	DIRTY_BIT_ATTRIBUTE Name of request attribute used as a dirty bit.
private static java.util.concurrent.locks.ReadWriteLock	DUMMY_LOCK A dummy lock implementation.
private javax.servlet.http.HttpServletRequest	httpServletRequest Servlet request.
private javax.servlet.http.HttpServletResponse	httpServletResponse Servlet response.
private net.shibboleth.utilities.java.support.security.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

Modifier and Type	Method and Description
boolean	create(java.lang.String context, java.lang.String key, java.lang.String value, java.lang.Long expiration) Creates a new record in the store with an expiration.
void	deleteContext(java.lang.String context) Forcibly removes all records in a given context along with any associated resources devoted to maintaining the context.
protected boolean	deleteImpl(java.lang.Long version, java.lang.String context, java.lang.String key) Internal method to implement delete functions.
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
protected void	doInitialize()
protected java.util.TimerTask	getCleanupTask() Returns a cleanup task function to schedule for background cleanup.
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,MutableStorageRecord>>	getContextMap() Get the map of contexts to manipulate during operations.
java.lang.String	getCookieName() Get the cookie name to use for storage tracking.
protected java.util.concurrent.locks.ReadWriteLock	getLock() Get the shared lock to synchronize access.
void	init(javax.servlet.FilterConfig filterConfig)
private boolean	isDirty() Get the dirty bit for the current request.
protected void	load() Reconstitute stored data.
void	reap(java.lang.String context) Manually trigger a cleanup of expired records.
protected void	save() Write/preserve stored data for subsequent requests.
void	setCleanupInterval(long interval) Sets the number of milliseconds between one cleanup and another.
void	setCookieManager(net.shibboleth.utilities.java.support.net.CookieManager manager) Set the CookieManager to use.
void	setCookieName(java.lang.String name) Set the cookie name to use for storage tracking.
void	setDataSealer(net.shibboleth.utilities.java.support.security.DataSealer sealer) Set the DataSealer to use for data security.
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(net.shibboleth.utilities.java.support.security.DataSealerKeyStrategy strategy) Set the DataSealerKeyStrategy to use for stale key detection.
void	updateContextExpiration(java.lang.String context, java.lang.Long expiration) Updates the expiration time of all records in the context.
protected java.lang.Long	updateImpl(java.lang.Long version, java.lang.String context, java.lang.String key, java.lang.String value, java.lang.Long expiration) Internal method to implement update functions.

Methods inherited from class org.opensaml.storage.AbstractMapBackedStorageService

delete, deleteWithVersion, read, read, readImpl, reapWithLock, update, 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, delete, delete, deleteWithVersion, deleteWithVersion, getCapabilities, read, read, read, update, update, update, 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

Field Detail

CONTEXT_MAP_ATTRIBUTE

@Nonnull
protected static final java.lang.String CONTEXT_MAP_ATTRIBUTE

Name of request attribute for context map.

See Also:

Constant Field Values

DIRTY_BIT_ATTRIBUTE

@Nonnull
protected static final java.lang.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 java.lang.String DEFAULT_COOKIE_NAME

Default cookie name for storage tracking.

See Also:

Constant Field Values

DUMMY_LOCK

@Nonnull
private static final java.util.concurrent.locks.ReadWriteLock DUMMY_LOCK

A dummy lock implementation.

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

httpServletRequest

@NonnullAfterInit
private javax.servlet.http.HttpServletRequest httpServletRequest

Servlet request.

httpServletResponse

@NonnullAfterInit
private javax.servlet.http.HttpServletResponse httpServletResponse

Servlet response.

cookieManager

@NonnullAfterInit
private net.shibboleth.utilities.java.support.net.CookieManager cookieManager

Manages creation of cookies.

cookieName

@Nonnull
 @NotEmpty
private java.lang.String cookieName

Name of cookie used to track storage.

dataSealer

@NonnullAfterInit
private net.shibboleth.utilities.java.support.security.DataSealer dataSealer

DataSealer instance to secure data.

keyStrategy

@Nullable
private net.shibboleth.utilities.java.support.security.DataSealerKeyStrategy keyStrategy

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

Constructor Detail

ServletRequestScopedStorageService

public ServletRequestScopedStorageService()

Constructor.

Method Detail

setCleanupInterval

public void setCleanupInterval(long interval)

Sets the number of milliseconds between one cleanup and another. A value of 0 indicates that no cleanup will be performed. This setting cannot be changed after the service has been initialized.

Overrides:

setCleanupInterval in class AbstractStorageService

Parameters:

interval - number of milliseconds between one cleanup and another

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
                             net.shibboleth.utilities.java.support.net.CookieManager manager)

Set the CookieManager to use.

Parameters:

manager - the CookieManager to use.

getCookieName

@Nonnull
 @NotEmpty
public java.lang.String getCookieName()

Get the cookie name to use for storage tracking.

Returns:

cookie name to use

setCookieName

public void setCookieName(@Nonnull @NotEmpty
                          java.lang.String name)

Set the cookie name to use for storage tracking.

Parameters:

name - cookie name to use

setDataSealer

public void setDataSealer(@Nonnull
                          net.shibboleth.utilities.java.support.security.DataSealer sealer)

Set the DataSealer to use for data security.

Parameters:

sealer - DataSealer to use for data security

setKeyStrategy

public void setKeyStrategy(@Nonnull
                           net.shibboleth.utilities.java.support.security.DataSealerKeyStrategy strategy)

Set the DataSealerKeyStrategy to use for stale key detection.

Parameters:

strategy - DataSealerKeyStrategy to use for stale key detection

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class AbstractStorageService

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

create

public boolean create(@Nonnull @NotEmpty
                      java.lang.String context,
                      @Nonnull @NotEmpty
                      java.lang.String key,
                      @Nonnull @NotEmpty
                      java.lang.String value,
                      @Nullable
                      java.lang.Long expiration)
               throws java.io.IOException

Creates a new record in the store with an expiration.

Specified by:

create in interface StorageService

Overrides:

create in class AbstractMapBackedStorageService

Parameters:

context - a storage context label

key - a key unique to context

value - value to store

expiration - expiration for record, or null

Returns:

true iff record was inserted, false iff a duplicate was found

Throws:

java.io.IOException - if fatal errors occur in the insertion process

updateContextExpiration

public void updateContextExpiration(@Nonnull @NotEmpty
                                    java.lang.String context,
                                    @Nullable
                                    java.lang.Long expiration)
                             throws java.io.IOException

Updates the expiration time of all records in the context.

Specified by:

updateContextExpiration in interface StorageService

Overrides:

updateContextExpiration in class AbstractMapBackedStorageService

Parameters:

context - a storage context label

expiration - a new expiration timestamp, or null

Throws:

java.io.IOException - if errors occur in the cleanup process

deleteContext

public void deleteContext(@Nonnull @NotEmpty
                          java.lang.String context)
                   throws java.io.IOException

Forcibly removes all records in a given context along with any associated resources devoted to maintaining the context.

Specified by:

deleteContext in interface StorageService

Overrides:

deleteContext in class AbstractMapBackedStorageService

Parameters:

context - a storage context label

Throws:

java.io.IOException - if errors occur in the cleanup process

reap

public void reap(@Nonnull @NotEmpty
                 java.lang.String context)
          throws java.io.IOException

Manually trigger a cleanup of expired records. The method MAY return without guaranteeing that cleanup has already occurred.

Specified by:

reap in interface StorageService

Overrides:

reap in class AbstractMapBackedStorageService

Parameters:

context - a storage context label

Throws:

java.io.IOException - if errors occur in the cleanup process

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 java.io.IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

java.io.IOException

javax.servlet.ServletException

load

protected void load()
             throws java.io.IOException

Reconstitute stored data.

Throws:

java.io.IOException - if an error occurs reconstituting the data

save

@Nullable
protected void save()
                       throws java.io.IOException

Write/preserve stored data for subsequent requests.

Throws:

java.io.IOException - if an error occurs preserving the data

updateImpl

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

Internal method to implement update functions.

Overrides:

updateImpl in class AbstractMapBackedStorageService

Parameters:

version - only update if the current version matches this value

context - a storage context label

key - a key unique to context

value - updated value

expiration - expiration for record. or null

Returns:

the version of the record after update, null if no record exists

Throws:

java.io.IOException - if errors occur in the update process

VersionMismatchException - if the record has already been updated to a newer version

deleteImpl

protected boolean deleteImpl(@Nullable @Positive
                             java.lang.Long version,
                             @Nonnull @NotEmpty
                             java.lang.String context,
                             @Nonnull @NotEmpty
                             java.lang.String key)
                      throws java.io.IOException,
                             VersionMismatchException

Internal method to implement delete functions.

Overrides:

deleteImpl in class AbstractMapBackedStorageService

Parameters:

version - only update if the current version matches this value

context - a storage context label

key - a key unique to context

Returns:

true iff the record existed and was deleted

Throws:

java.io.IOException - if errors occur in the update process

VersionMismatchException - if the record has already been updated to a newer version

getCleanupTask

@Nullable
protected java.util.TimerTask getCleanupTask()

Returns a cleanup task function to schedule for background cleanup.

The default implementation does not supply one.

Overrides:

getCleanupTask in class AbstractStorageService

Returns:

a task object, or null

getContextMap

@Nonnull
 @NonnullElements
 @Live
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,MutableStorageRecord>> getContextMap()

Get the map of contexts to manipulate during operations.

Specified by:

getContextMap in class AbstractMapBackedStorageService

Returns:

map of contexts to manipulate

getLock

@Nonnull
protected java.util.concurrent.locks.ReadWriteLock getLock()

Get the shared lock to synchronize access.

Specified by:

getLock in class AbstractMapBackedStorageService

Returns:

shared lock

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