org.opensaml.storage

Class AbstractMapBackedStorageService

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

All Implemented Interfaces:

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, StorageCapabilities, StorageService

Direct Known Subclasses:

MemoryStorageService, ServletRequestScopedStorageService

public abstract class AbstractMapBackedStorageService
extends AbstractStorageService

Partial implementation of StorageService that stores data in-memory with no persistence using a simple map.

Abstract methods supply the map of data to manipulate and the lock to use, which allows optimizations in cases where locking isn't required or data isn't shared.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
AbstractMapBackedStorageService() 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.
boolean	delete(java.lang.String context, java.lang.String key) Deletes an existing record from the store.
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.
boolean	deleteWithVersion(long version, java.lang.String context, java.lang.String key) Deletes an existing record from the store if it currently has a specified version.
protected abstract java.util.Map<java.lang.String,java.util.Map<java.lang.String,MutableStorageRecord>>	getContextMap() Get the map of contexts to manipulate during operations.
protected abstract java.util.concurrent.locks.ReadWriteLock	getLock() Get the shared lock to synchronize access.
StorageRecord	read(java.lang.String context, java.lang.String key) Returns an existing record from the store, if one exists.
net.shibboleth.utilities.java.support.collection.Pair<java.lang.Long,StorageRecord>	read(java.lang.String context, java.lang.String key, long version) Returns an existing record from the store, along with its version.
protected net.shibboleth.utilities.java.support.collection.Pair<java.lang.Long,StorageRecord>	readImpl(java.lang.String context, java.lang.String key, java.lang.Long version) Internal method to implement read functions.
void	reap(java.lang.String context) Manually trigger a cleanup of expired records.
protected boolean	reapWithLock(java.util.Map<java.lang.String,MutableStorageRecord> dataMap, long expiration) Locates and removes expired records from the input map.
boolean	update(java.lang.String context, java.lang.String key, java.lang.String value, java.lang.Long expiration) Updates an existing record in the store.
void	updateContextExpiration(java.lang.String context, java.lang.Long expiration) Updates the expiration time of all records in the context.
boolean	updateExpiration(java.lang.String context, java.lang.String key, java.lang.Long expiration) Updates expiration of an existing record in the store.
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.
java.lang.Long	updateWithVersion(long version, java.lang.String context, java.lang.String key, java.lang.String value, java.lang.Long expiration) Updates an existing record in the store, if a version matches.

Methods inherited from class org.opensaml.storage.AbstractStorageService

create, create, delete, deleteWithVersion, doDestroy, doInitialize, getCapabilities, getCleanupInterval, getCleanupTask, getCleanupTaskTimer, getContextSize, getKeySize, getValueSize, read, setCleanupInterval, 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 net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

Constructor Detail

AbstractMapBackedStorageService

public AbstractMapBackedStorageService()

Constructor.

Method Detail

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.

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

read

@Nullable
public StorageRecord read(@Nonnull @NotEmpty
                                    java.lang.String context,
                                    @Nonnull @NotEmpty
                                    java.lang.String key)
                             throws java.io.IOException

Returns an existing record from the store, if one exists.

Parameters:

context - a storage context label

key - a key unique to context

Returns:

the record read back, if present, or null

Throws:

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

read

@Nonnull
public net.shibboleth.utilities.java.support.collection.Pair<java.lang.Long,StorageRecord> read(@Nonnull @NotEmpty
                                                                                                         java.lang.String context,
                                                                                                         @Nonnull @NotEmpty
                                                                                                         java.lang.String key,
                                                                                                         long version)
                                                                                                  throws java.io.IOException

Returns an existing record from the store, along with its version.

The first member of the pair returned will contain the version of the record in the store, or will be null if no record exists. The second member will contain the record read back. If null, the record either didn't exist (if the first member was also null) or the record was the same version as that supplied by the caller.

Parameters:

context - a storage context label

key - a key unique to context

version - only return record if newer than supplied version

Returns:

a pair consisting of the version of the record read back, if any, and the record itself

Throws:

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

update

public boolean update(@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

Updates an existing record in the store.

Parameters:

context - a storage context label

key - a key unique to context

value - updated value

expiration - expiration for record, or null

Returns:

true if the update succeeded, false if the record does not exist

Throws:

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

updateWithVersion

@Nullable
public java.lang.Long updateWithVersion(long version,
                                                  @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,
                                                  VersionMismatchException

Updates an existing record in the store, if a version matches.

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

updateExpiration

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

Updates expiration of an existing record in the store.

Parameters:

context - a storage context label

key - a key unique to context

expiration - expiration for record, or null

Returns:

true if the update succeeded, false if the record does not exist

Throws:

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

deleteWithVersion

public boolean deleteWithVersion(long version,
                                 java.lang.String context,
                                 java.lang.String key)
                          throws java.io.IOException,
                                 VersionMismatchException

Deletes an existing record from the store if it currently has a specified version.

Parameters:

version - record version to delete

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 deletion process

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

delete

public boolean delete(@Nonnull @NotEmpty
                      java.lang.String context,
                      @Nonnull @NotEmpty
                      java.lang.String key)
               throws java.io.IOException

Deletes an existing record from the store.

Parameters:

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

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.

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.

Parameters:

context - a storage context label

Throws:

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

getContextMap

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

Get the map of contexts to manipulate during operations.

Returns:

map of contexts to manipulate

getLock

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

Get the shared lock to synchronize access.

Returns:

shared lock

readImpl

@Nonnull
protected net.shibboleth.utilities.java.support.collection.Pair<java.lang.Long,StorageRecord> readImpl(@Nonnull @NotEmpty
                                                                                                                java.lang.String context,
                                                                                                                @Nonnull @NotEmpty
                                                                                                                java.lang.String key,
                                                                                                                @Nullable
                                                                                                                java.lang.Long version)
                                                                                                         throws java.io.IOException

Internal method to implement read functions.

Parameters:

context - a storage context label

key - a key unique to context

version - only return record if newer than optionally supplied version

Returns:

a pair consisting of the version of the record read back, if any, and the record itself

Throws:

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

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.

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.

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

reapWithLock

protected boolean reapWithLock(@Nonnull @NonnullElements
                               java.util.Map<java.lang.String,MutableStorageRecord> dataMap,
                               long expiration)

Locates and removes expired records from the input map.

This method MUST be called while holding a write lock, if locking is required.

Parameters:

dataMap - the map to reap

expiration - time at which to consider records expired

Returns:

true iff anything was purged