Package net.shibboleth.sp.storage.impl

Class ResourceBackedMemoryStorageService

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

org.opensaml.storage.AbstractStorageService

org.opensaml.storage.AbstractMapBackedStorageService

net.shibboleth.sp.storage.impl.ResourceBackedMemoryStorageService

All Implemented Interfaces:

Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, EnumeratableStorageService, StorageCapabilities, StorageService

public class ResourceBackedMemoryStorageService
extends AbstractMapBackedStorageService
implements StorageCapabilities

Implementation of AbstractMapBackedStorageService that stores data in-memory in a shared data structure after loading it from a resource containing a simple one-line per record, delimited format.

Records do not carry expirations.

The implementation is read-only and throws exceptions for any methods that would mutate the data. The "cleanup" task is instead used to periodically check the source file for updates and reloads the in-memory data under an exclusive lock.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,Map<String,MutableStorageRecord<?>>>	contextMap	Map of contexts.
private String	delimiter	Field delimiter in resource.
private long	lastModified	File timestamp.
private ReadWriteLock	lock	A shared lock to synchronize access.
private final org.slf4j.Logger	log	Class logger.
private Resource	storageResource	Source of information.

Constructor Summary

Constructors

Constructor	Description
ResourceBackedMemoryStorageService()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	create(String context, String key, String value, Long expiration)
void	deleteContext(String context)
protected boolean	deleteImpl(Long version, String context, String key)
protected void	doInitialize()
protected TimerTask	getCleanupTask()
protected Map<String,Map<String,MutableStorageRecord<?>>>	getContextMap()
protected ReadWriteLock	getLock()
boolean	isClustered()
boolean	isServerSide()
private Map<String,Map<String,MutableStorageRecord<?>>>	load(InputStream is)	Loads data from the supplied input stream.
void	setDelimiter(String delim)	Set the field delimiter to use to split the records.
void	setReloadInterval(Duration interval)	Sets the time between checks for changes to the resource and reload of the records.
void	setResource(Resource resource)	Set the resource to use.
void	updateContextExpiration(String context, Long expiration)
protected Long	updateImpl(Long version, String context, String key, String value, Long expiration)

Methods inherited from class org.opensaml.storage.AbstractMapBackedStorageService

delete, deleteWithVersion, getContextKeys, read, read, readImpl, reap, reapWithLock, setDirty, update, updateExpiration, updateWithVersion

Methods inherited from class org.opensaml.storage.AbstractStorageService

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

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, 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 net.shibboleth.shared.component.IdentifiedComponent

getId

Methods inherited from interface org.opensaml.storage.StorageCapabilities

getContextSize, getKeySize, getValueSize

Methods inherited from interface org.opensaml.storage.StorageService

create, create, delete, deleteWithVersion, getCapabilities, read, update, update, updateExpiration, updateWithVersion, updateWithVersion

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

contextMap

@NonnullAfterInit
private Map<String,Map<String,MutableStorageRecord<?>>> contextMap

Map of contexts.

lock

@NonnullAfterInit
private ReadWriteLock lock

A shared lock to synchronize access.

storageResource

@Nullable
private Resource storageResource

Source of information.

delimiter

@Nonnull
@NotEmpty
private String delimiter

Field delimiter in resource.

lastModified

private long lastModified

File timestamp.

Constructor Details

ResourceBackedMemoryStorageService

public ResourceBackedMemoryStorageService()

Constructor.

Method Details

isServerSide

public boolean isServerSide()

Specified by:

isServerSide in interface StorageCapabilities

isClustered

public boolean isClustered()

Specified by:

isClustered in interface StorageCapabilities

setReloadInterval

public void setReloadInterval(@Nonnull
 Duration interval)

Sets the time between checks for changes to the resource and reload of the records.

A value of 0 (the default) indicates that no reloading will be performed.

Non-file resources are detected and reload is skipped, though the task may still run and log warnings.

Parameters:

interval - time between reload checking

setResource

public void setResource(@Nonnull
 Resource resource)

Set the resource to use.

Parameters:

resource - resource to use

setDelimiter

public void setDelimiter(@Nonnull @NotEmpty
 String delim)

Set the field delimiter to use to split the records.

Defaults to "," (comma).

Parameters:

delim - delimiter string

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractStorageService

Throws:

ComponentInitializationException

getContextMap

@Nonnull
@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

create

public boolean create(String context,
 String key,
 String value,
 Long expiration)
               throws IOException

Specified by:

create in interface StorageService

Overrides:

create in class AbstractMapBackedStorageService

Throws:

IOException

updateImpl

protected Long updateImpl(Long version,
 String context,
 String key,
 String value,
 Long expiration)
                   throws IOException,
VersionMismatchException

Overrides:

updateImpl in class AbstractMapBackedStorageService

Throws:

IOException

VersionMismatchException

updateContextExpiration

public void updateContextExpiration(@Nonnull @NotEmpty
 String context,
 @Nullable
 Long expiration)

Specified by:

updateContextExpiration in interface StorageService

Overrides:

updateContextExpiration in class AbstractMapBackedStorageService

deleteImpl

protected boolean deleteImpl(Long version,
 String context,
 String key)
                      throws IOException,
VersionMismatchException

Overrides:

deleteImpl in class AbstractMapBackedStorageService

Throws:

IOException

VersionMismatchException

deleteContext

public void deleteContext(@Nonnull @NotEmpty
 String context)
                   throws IOException

Specified by:

deleteContext in interface StorageService

Overrides:

deleteContext in class AbstractMapBackedStorageService

Throws:

IOException

getCleanupTask

@Nullable
protected TimerTask getCleanupTask()

Overrides:

getCleanupTask in class AbstractStorageService

load

@Nonnull
@Unmodifiable
@NotLive
private Map<String,Map<String,MutableStorageRecord<?>>> load(@Nonnull
 InputStream is)
                                                      throws IOException

Loads data from the supplied input stream.

Must be called while holding the write lock.

Parameters:

is -

Returns:

the constructed map of records

Throws:

IOException - on error