org.opensaml.storage.impl

Class JPAStorageService

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.impl.JPAStorageService

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

public class JPAStorageService
extends AbstractStorageService

Implementation of StorageService that uses JPA to persist to a database.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.persistence.EntityManagerFactory	entityManagerFactory Entity manager factory.
private org.slf4j.Logger	log Class logger.
private int	transactionRetry Number of times to retry a transaction if it rolls back.

Constructor Summary

Constructors

Constructor and Description
JPAStorageService(javax.persistence.EntityManagerFactory factory) Creates a new JPA storage service.

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 void	deleteContextImpl(java.lang.String context, java.lang.Long expiration) Deletes every record with the supplied context.
protected boolean	deleteImpl(java.lang.Long version, java.lang.String context, java.lang.String key) Deletes the record matching the supplied parameters.
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 void	doDestroy()
private <T> java.util.List<T>	executeNamedQuery(javax.persistence.EntityManager manager, java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.Class<T> clazz, javax.persistence.LockModeType lockMode) Executes the supplied named query.
protected java.util.TimerTask	getCleanupTask() Returns a cleanup task function to schedule for background cleanup.
int	getTransactionRetry() Returns the number of times a transaction will be retried if a RollbackException is encountered.
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.
java.util.List<StorageRecord>	readAll() Returns all records from the store.
java.util.List<StorageRecord>	readAll(java.lang.String context) Returns all records from the store for the supplied context.
java.util.List<java.lang.String>	readContexts() Returns all contexts from the store.
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) Reads the record matching the supplied parameters.
void	reap(java.lang.String context) Manually trigger a cleanup of expired records.
void	setTransactionRetry(int retry) Sets the number of times a transaction will be retried.
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) Updates the record matching the supplied parameters.
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, doInitialize, getCapabilities, getCleanupInterval, 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.

entityManagerFactory

@Nonnull
private final javax.persistence.EntityManagerFactory entityManagerFactory

Entity manager factory.

transactionRetry

@NonNegative
private int transactionRetry

Number of times to retry a transaction if it rolls back. Default value is .

Constructor Detail

JPAStorageService

public JPAStorageService(@Nonnull
                         javax.persistence.EntityManagerFactory factory)

Creates a new JPA storage service.

Parameters:

factory - entity manager factory

Method Detail

getTransactionRetry

public int getTransactionRetry()

Returns the number of times a transaction will be retried if a RollbackException is encountered.

Returns:

number of transaction retries

setTransactionRetry

public void setTransactionRetry(int retry)

Sets the number of times a transaction will be retried.

Parameters:

retry - number of transaction retries

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractStorageService

create

public boolean create(@Nonnull @NotEmpty
                      java.lang.String context,
                      @Nonnull @NotEmpty
                      java.lang.String key,
                      @Nonnull @NotEmpty
                      java.lang.String value,
                      @Nullable @Positive
                      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

readAll

@Nonnull
 @NonnullElements
public java.util.List<StorageRecord> readAll()
                                                                 throws java.io.IOException

Returns all records from the store.

Returns:

all records or an empty list

Throws:

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

readAll

@Nonnull
 @NonnullElements
public java.util.List<StorageRecord> readAll(@Nonnull @NotEmpty
                                                                        java.lang.String context)
                                                                 throws java.io.IOException

Returns all records from the store for the supplied context.

Parameters:

context - a storage context label

Returns:

all records in the context or an empty list

Throws:

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

readContexts

@Nonnull
 @NonnullElements
public java.util.List<java.lang.String> readContexts()
                                                                         throws java.io.IOException

Returns all contexts from the store.

Returns:

all contexts or an empty list

Throws:

java.io.IOException - if errors occur in the read 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,
                                                                                                         @Positive
                                                                                                         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

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,
                                                                                                                @Positive
                                                                                                                java.lang.Long version)
                                                                                                         throws java.io.IOException

Reads the record matching the supplied parameters. Returns an empty pair if the record cannot be found or is expired.

Parameters:

context - to search for

key - to search for

version - to match

Returns:

pair of version and storage record

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 @Positive
                      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(@Positive
                                                  long version,
                                                  @Nonnull @NotEmpty
                                                  java.lang.String context,
                                                  @Nonnull @NotEmpty
                                                  java.lang.String key,
                                                  @Nonnull @NotEmpty
                                                  java.lang.String value,
                                                  @Nullable @Positive
                                                  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 @Positive
                                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

updateImpl

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

Updates the record matching the supplied parameters. Returns null if the record cannot be found or is expired.

Parameters:

version - to check

context - to search for

key - to search for

value - to update

expiration - to update

Returns:

whether the record was updated

Throws:

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

VersionMismatchException - if the record found contains a version that does not match the parameter

deleteWithVersion

public boolean deleteWithVersion(@Positive
                                 long version,
                                 @Nonnull @NotEmpty
                                 java.lang.String context,
                                 @Nonnull @NotEmpty
                                 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

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

Deletes the record matching the supplied parameters.

Parameters:

version - to check

context - to search for

key - to search for

Returns:

whether the record was deleted

Throws:

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

VersionMismatchException - if the record found contains a version that does not match the parameter

updateContextExpiration

public void updateContextExpiration(@Nonnull @NotEmpty
                                    java.lang.String context,
                                    @Nullable @Positive
                                    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

deleteContextImpl

protected void deleteContextImpl(@Nonnull @NotEmpty
                                 java.lang.String context,
                                 @Nonnull
                                 java.lang.Long expiration)
                          throws java.io.IOException

Deletes every record with the supplied context. If expiration is supplied, only records with an expiration before the supplied expiration will be removed.

Parameters:

context - to delete

expiration - (optional) to require for deletion

Throws:

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

executeNamedQuery

private <T> java.util.List<T> executeNamedQuery(@Nonnull
                                                javax.persistence.EntityManager manager,
                                                @Nonnull @NotEmpty
                                                java.lang.String query,
                                                @Nonnull
                                                java.util.Map<java.lang.String,java.lang.Object> params,
                                                @Nonnull
                                                java.lang.Class<T> clazz,
                                                @Nonnull
                                                javax.persistence.LockModeType lockMode)
                                         throws java.io.IOException

Executes the supplied named query.

Type Parameters:

T - type of entity to return

Parameters:

manager - to execute the query

query - to execute

params - parameters for the query

clazz - type of entity to return

lockMode - of the transaction

Returns:

query results or an empty list

Throws:

java.io.IOException - if an error occurs executing the query

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