Package net.shibboleth.plugin.storage.jdbc.impl

Class JDBCStorageService

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

org.opensaml.storage.AbstractStorageService

net.shibboleth.plugin.storage.jdbc.impl.JDBCStorageService

All Implemented Interfaces:

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

public final class JDBCStorageService
extends AbstractStorageService
implements StorageCapabilities, EnumeratableStorageService

Implementation of StorageService that uses native JDBC to persist to a database.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	JDBCStorageService.ConnectionWithLock	A Class to encapsulate a Connection protected by an optional read/write lock.

Field Summary

Fields

Modifier and Type	Field	Description
private String	createCreateRecordSQL	The SQL to create a new record (transactional with preCreateQuerySQL.
private String	createUpdateRecordSQL	The SQL to update an expired record as part of a create (transactional with preCreateQuerySQL.
private DataSource	dataSource	The Data Source.
(package private) static final String	DEFAULT_CREATE_CREATE_RECORD_SQL	The SQL to create a new record.
(package private) static final String	DEFAULT_CREATE_UPDATE_RECORD_SQL	The SQL to update an expired record as part of a create.
(package private) static final String	DEFAULT_DELETE_BY_CONTEXT_EXPIRED_SQL	The SQL to delete all records by specified context and expiration.
(package private) static final String	DEFAULT_DELETE_BY_CONTEXT_SQL	The SQL to delete a given context.
(package private) static final String	DEFAULT_DELETE_BY_EXPIRED_SQL	The SQL to delete all records by specified expiration.
(package private) static final String	DEFAULT_DELETE_RECORD_SQL	The SQL to delete a record.
(package private) static final String	DEFAULT_GET_CONTEXT_KEYS_SQL	The SQL to fetch the keys in a context.
(package private) static final String	DEFAULT_GET_CONTEXT_KEYS_WITH_PREFIX_SQL	The SQL to fetch matching keys in a context.
(package private) static final String	DEFAULT_PRE_CREATE_QUERY_SQL	The SQL to get check whether this record already exists and is unexpired prior to a create.
(package private) static final String	DEFAULT_PRE_DELETE_QUERY_SQL	The SQL to check whether a record exists prior to deleting it.
(package private) static final String	DEFAULT_PRE_UPDATE_QUERY_SQL	The SQL to check whether a record exists prior to updating it.
(package private) static final String	DEFAULT_READ_ALL_BY_CONTEXT_SQL	The SQL to get all the records for a specific context.
(package private) static final String	DEFAULT_READ_ALL_SQL	The SQL to get all the records.
(package private) static final String	DEFAULT_READ_CONTEXTS_SQL	The SQL to get all the contexts.
(package private) static final String	DEFAULT_READ_RECORD_SQL	The SQL to read a single record.
(package private) static final String	DEFAULT_UPDATE_EXPIRES_BY_CONTEXT_SQL	The SQL to update the expiration for a given context.
(package private) static final String	DEFAULT_UPDATE_RECORD_SQL	The SQL to update a record.
private String	deleteByContextExpiredSQL	The SQL to delete expired record with specified context.
private String	deleteByContextSQL	The SQL to to delete a given context.
private String	deleteByExpiredSQL	The SQL to delete expired record.
private String	deleteRecordSQL	The SQL to delete a record.
private String	getContextKeysSQL	The SQL to fetch the keys in a context.
private String	getContextKeysWithPrefixSQL	The SQL to fetch the keys in a context with a prefix.
private final org.slf4j.Logger	log	Class logger.
private String	preCreateQuerySQL	The SQL to get check whether this record already exists and is unexpired prior to a create.
private String	preDeleteQuerySQL	The SQL to check whether a record exists prior to deleting it.
private String	preUpdateQuerySQL	The SQL to check whether a record exists prior to updating it.
private Duration	queryTimeout	Timeout of SQL queries.
private String	readAllByContextSQL	The SQL to get all the records for a specific context.
private String	readAllSQL	The SQL to get all the records.
private String	readContextsSQL	The SQL to get all the contexts.
private String	readRecordSQL	The SQL to read a single record.
private ReadWriteLock	readWriteLock	If non-null we doing local locking.
private Collection<String>	retryableErrors	Error messages that signal a transaction should be retried.
private int	transactionIsolation	What transaction isolation do we want?
private int	transactionRetries	How many times do we try an operation before giving up?
private String	updateExpiresByContextSQL	The SQL to update the expiration of a given context.
private String	updateRecordSQL	The SQL to update a record.
private boolean	verify	Are we verifying the database during initialize?
(package private) static final String	VERIFY_STRING	The context, key and value we test the database with.

Constructor Summary

Constructors

Constructor	Description
JDBCStorageService()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	create(String context, String key, String value, Long expiration)
boolean	delete(String context, String key)
void	deleteContext(String context)
protected void	deleteImpl(Long expiration)	Deletes every record with an expiration before the supplied expiration.
protected boolean	deleteImpl(Long version, String context, String key)	Deletes the record matching the supplied parameters.
boolean	deleteWithVersion(long version, String context, String key)
protected void	doInitialize()
protected TimerTask	getCleanupTask()
Iterable<String>	getContextKeys(String context, String prefix)
private static Long	getExpires(ResultSet results, int columm)	Return the value of expires in the supplied column of the supplied ResultSet.
boolean	isClustered()
boolean	isServerSide()
<T> StorageRecord<T>	read(String context, String key)
<T> Pair<Long,StorageRecord<T>>	read(String context, String key, long version)
protected List<?>	readAll()	Returns all records from the store (for testing only).
protected List<?>	readAll(String context)	Returns all records from the store for the supplied context (for testing only).
protected List<String>	readContexts()	Returns all contexts from the store (for testing only).
protected <T> Pair<Long,StorageRecord<T>>	readImpl(String context, String key, Long version)	Reads the record matching the supplied parameters.
void	reap(String context)
void	setCreateCreateRecordSQL(String what)	Set the SQL to create a new record (transactional with preCreateQuerySQL.
void	setCreateUpdateRecordSQL(String what)	Set the SQL to update an expired record as part of a create (transactional with preCreateQuerySQL.
void	setDataSource(DataSource source)	Set the DataSource.
void	setDeleteByContextExpiredSQL(String what)	Set the SQL to delete expired record with specified context.
void	setDeleteByContextSQL(String what)	Set the SQL to Delete a specified Context.
void	setDeleteByExpiredSQL(String what)	Set the SQL to delete expired record.
void	setDeleteRecordSQL(String what)	Set the SQL to delete a record.
private static void	setExpires(PreparedStatement stmnt, int column, Long expires)	Set the value of expiration into the prepared statement at the suppiled column converting java nulls into SQL nulls.
void	setGetContextKeysSQL(String what)	Set the SQL to fetch the keys in a specified context.
void	setLocalLocking(boolean what)	Will we do thread level locking or delegate to the Database?
void	setPreCreateQuerySQL(String what)	Set the SQL to get check whether this record already exists and is unexpired prior to a create.
void	setPreDeleteQuerySQL(String what)	Set the SQL to check whether a record exists prior to deleting it.
void	setPreUpdateQuerySQL(String what)	Set the SQL to get check whether this record already exists and is unexpired prior to an update.
void	setReadAllByContextSQL(String what)	SQL to read all contexts.
void	setReadAllSQL(String what)	SQL to read all contexts.
void	setReadContextsSQL(String what)	SQL to read contexts.
void	setReadRecordSQL(String what)	Set the SQL to read a single record.
void	setRetryableErrors(List<String> errors)	What errors do we retry?
void	setTransactionIsolation(int what)	Set the parameter that will be passed to Connection.setTransactionIsolation(int).
void	setTransactionRetries(int count)	set transactionRetries.
void	setUpdateExpiresByContextSQL(String what)	Set the SQL to update the expiration of a record specified by context.
void	setUpdateRecordSQL(String what)	Set the SQL to update a record.
void	setVerify(boolean what)	Set whether we are to verify the database during initialize.
boolean	update(String context, String key, String value, Long expiration)
void	updateContextExpiration(String context, Long expires)
boolean	updateExpiration(String context, String key, Long expiration)
protected Long	updateImpl(Long version, String context, String key, String value, Long expires)	Updates the record matching the supplied parameters.
Long	updateWithVersion(long version, String context, String key, String value, Long expiration)
private void	verifyDatabase()	Check the database and the presence of a uniqueness constraint.

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

VERIFY_STRING

static final String VERIFY_STRING

The context, key and value we test the database with.

See Also:

• Constant Field Values

DEFAULT_READ_CONTEXTS_SQL

static final String DEFAULT_READ_CONTEXTS_SQL

The SQL to get all the contexts.

See Also:

• Constant Field Values

DEFAULT_READ_ALL_SQL

static final String DEFAULT_READ_ALL_SQL

The SQL to get all the records.

See Also:

• Constant Field Values

DEFAULT_READ_ALL_BY_CONTEXT_SQL

static final String DEFAULT_READ_ALL_BY_CONTEXT_SQL

The SQL to get all the records for a specific context.

See Also:

• Constant Field Values

DEFAULT_PRE_CREATE_QUERY_SQL

static final String DEFAULT_PRE_CREATE_QUERY_SQL

The SQL to get check whether this record already exists and is unexpired prior to a create.

See Also:

• Constant Field Values

DEFAULT_CREATE_CREATE_RECORD_SQL

static final String DEFAULT_CREATE_CREATE_RECORD_SQL

The SQL to create a new record.

See Also:

• Constant Field Values

DEFAULT_CREATE_UPDATE_RECORD_SQL

static final String DEFAULT_CREATE_UPDATE_RECORD_SQL

The SQL to update an expired record as part of a create.

See Also:

• Constant Field Values

DEFAULT_READ_RECORD_SQL

static final String DEFAULT_READ_RECORD_SQL

The SQL to read a single record.

See Also:

• Constant Field Values

DEFAULT_PRE_UPDATE_QUERY_SQL

static final String DEFAULT_PRE_UPDATE_QUERY_SQL

The SQL to check whether a record exists prior to updating it.

See Also:

• Constant Field Values

DEFAULT_UPDATE_RECORD_SQL

static final String DEFAULT_UPDATE_RECORD_SQL

The SQL to update a record.

See Also:

• Constant Field Values

DEFAULT_PRE_DELETE_QUERY_SQL

static final String DEFAULT_PRE_DELETE_QUERY_SQL

The SQL to check whether a record exists prior to deleting it.

See Also:

• Constant Field Values

DEFAULT_DELETE_RECORD_SQL

static final String DEFAULT_DELETE_RECORD_SQL

The SQL to delete a record.

See Also:

• Constant Field Values

DEFAULT_DELETE_BY_EXPIRED_SQL

static final String DEFAULT_DELETE_BY_EXPIRED_SQL

The SQL to delete all records by specified expiration.

See Also:

• Constant Field Values

DEFAULT_DELETE_BY_CONTEXT_EXPIRED_SQL

static final String DEFAULT_DELETE_BY_CONTEXT_EXPIRED_SQL

The SQL to delete all records by specified context and expiration.

See Also:

• Constant Field Values

DEFAULT_UPDATE_EXPIRES_BY_CONTEXT_SQL

static final String DEFAULT_UPDATE_EXPIRES_BY_CONTEXT_SQL

The SQL to update the expiration for a given context.

See Also:

• Constant Field Values

DEFAULT_DELETE_BY_CONTEXT_SQL

static final String DEFAULT_DELETE_BY_CONTEXT_SQL

The SQL to delete a given context.

See Also:

• Constant Field Values

DEFAULT_GET_CONTEXT_KEYS_SQL

static final String DEFAULT_GET_CONTEXT_KEYS_SQL

The SQL to fetch the keys in a context.

See Also:

• Constant Field Values

DEFAULT_GET_CONTEXT_KEYS_WITH_PREFIX_SQL

static final String DEFAULT_GET_CONTEXT_KEYS_WITH_PREFIX_SQL

The SQL to fetch matching keys in a context.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

queryTimeout

@Nonnull
private Duration queryTimeout

Timeout of SQL queries.

transactionRetries

private int transactionRetries

How many times do we try an operation before giving up?

transactionIsolation

private int transactionIsolation

What transaction isolation do we want?

readWriteLock

private ReadWriteLock readWriteLock

If non-null we doing local locking.

verify

private boolean verify

Are we verifying the database during initialize?

retryableErrors

@Nonnull
@NonnullElements
private Collection<String> retryableErrors

Error messages that signal a transaction should be retried.

dataSource

@NonnullAfterInit
private DataSource dataSource

The Data Source.

readContextsSQL

@Nonnull
@NotEmpty
private String readContextsSQL

The SQL to get all the contexts. Default: "SELECT context FROM StorageRecords".

readAllSQL

@Nonnull
@NotEmpty
private String readAllSQL

The SQL to get all the records. Default: "SELECT context, id, expires, value, version FROM StorageRecords".

readAllByContextSQL

@Nonnull
@NotEmpty
private String readAllByContextSQL

The SQL to get all the records for a specific context. Default: "SELECT id, expires, value, version FROM StorageRecords WHERE context=?"

preCreateQuerySQL

@Nonnull
@NotEmpty
private String preCreateQuerySQL

The SQL to get check whether this record already exists and is unexpired prior to a create. Default: "SELECT expires FROM StorageRecords WHERE context=? AND id=?"

createCreateRecordSQL

@Nonnull
@NotEmpty
private String createCreateRecordSQL

The SQL to create a new record (transactional with preCreateQuerySQL. Default: "INSERT INTO StorageRecords(context, id, expires, value, version) VALUES (?, ?, ?, ?, 1)"

createUpdateRecordSQL

@Nonnull
@NotEmpty
private String createUpdateRecordSQL

The SQL to update an expired record as part of a create (transactional with preCreateQuerySQL. Default: "UPDATE StorageRecords SET value=?, version=1, expires=? WHERE context=? AND id=?"

readRecordSQL

@Nonnull
@NotEmpty
private String readRecordSQL

The SQL to read a single record. Default: "SELECT version, expires, value FROM StorageRecords WHERE context=? AND id=?"

preUpdateQuerySQL

@Nonnull
@NotEmpty
private String preUpdateQuerySQL

The SQL to check whether a record exists prior to updating it. Default: "SELECT version, expires, value FROM StorageRecords WHERE context=? AND id=?"

updateRecordSQL

@Nonnull
@NotEmpty
private String updateRecordSQL

The SQL to update a record. Transactional with preUpdateQuerySQL. Default: "UPDATE StorageRecords SET value=?, version=?, expires=? WHERE context=? AND id=?"

preDeleteQuerySQL

@Nonnull
@NotEmpty
private String preDeleteQuerySQL

The SQL to check whether a record exists prior to deleting it. Default: "SELECT version FROM StorageRecords WHERE context=? AND id=?"

deleteRecordSQL

@Nonnull
@NotEmpty
private String deleteRecordSQL

The SQL to delete a record. Transactional with preDeleteQuerySQL Default: "DELETE FROM StorageRecords WHERE context=? AND id=?"

deleteByExpiredSQL

@Nonnull
@NotEmpty
private String deleteByExpiredSQL

The SQL to delete expired record. Used as part of the getCleanupTask(). Default: "DELETE FROM StorageRecords WHERE expires <= ? "

deleteByContextExpiredSQL

@Nonnull
@NotEmpty
private String deleteByContextExpiredSQL

The SQL to delete expired record with specified context. Used as part of reap(String). Default: "DELETE FROM StorageRecords WHERE context = ? AND expires <= ?"

updateExpiresByContextSQL

@Nonnull
@NotEmpty
private String updateExpiresByContextSQL

The SQL to update the expiration of a given context. Default: "UPDATE StorageRecords SET expires=? WHERE context = ? AND expires > ?"

deleteByContextSQL

@Nonnull
@NotEmpty
private String deleteByContextSQL

The SQL to to delete a given context. Default: "DELETE FROM StorageRecords WHERE context=?"

getContextKeysSQL

@Nonnull
@NotEmpty
private String getContextKeysSQL

The SQL to fetch the keys in a context. Default: "SELECT id FROM StorageRecords WHERE context=? AND (expires IS NULL OR expires > ?)"

getContextKeysWithPrefixSQL

@Nonnull
@NotEmpty
private String getContextKeysWithPrefixSQL

The SQL to fetch the keys in a context with a prefix. Default: "SELECT id FROM StorageRecords WHERE context=? AND id like ? AND (expires IS NULL OR expires > ?)"

Constructor Details

JDBCStorageService

public JDBCStorageService()

Constructor. Set the defaults so that they can be over-ridden by Spring.

Method Details

setTransactionRetries

public void setTransactionRetries(@Positive
 int count)

set transactionRetries.

Parameters:

count - how many time to try before we bail.

setLocalLocking

public void setLocalLocking(boolean what)

Will we do thread level locking or delegate to the Database?

Parameters:

what - do we want to lock locally?

setVerify

public void setVerify(boolean what)

Set whether we are to verify the database during initialize.

Parameters:

what - the value to set

setTransactionIsolation

public void setTransactionIsolation(int what)

Set the parameter that will be passed to Connection.setTransactionIsolation(int).

Parameters:

what - the value to set

setDataSource

public void setDataSource(@Nonnull
 DataSource source)

Set the DataSource.

Parameters:

source - what to set.

setRetryableErrors

public void setRetryableErrors(@Nonnull @NonnullElements
 List<String> errors)

What errors do we retry?

Parameters:

errors - what to set.

setReadContextsSQL

public void setReadContextsSQL(@Nonnull @NotEmpty
 String what)

SQL to read contexts.

Parameters:

what - the SQL to set.

setReadAllByContextSQL

public void setReadAllByContextSQL(@Nonnull @NotEmpty
 String what)

SQL to read all contexts.

Parameters:

what - the SQL to set.

setReadAllSQL

public void setReadAllSQL(@Nonnull @NotEmpty
 String what)

SQL to read all contexts.

Parameters:

what - the SQL to set.

setPreCreateQuerySQL

public void setPreCreateQuerySQL(@Nonnull @NotEmpty
 String what)

Set the SQL to get check whether this record already exists and is unexpired prior to a create. This starts a transaction which will be completed after either the SQL in createCreateRecordSQL or createUpdateRecordSQL.

Parameters:

what - the SQL to set.

setCreateCreateRecordSQL

public void setCreateCreateRecordSQL(@Nonnull @NotEmpty
 String what)

Set the SQL to create a new record (transactional with preCreateQuerySQL.

Parameters:

what - the SQl to set.

setCreateUpdateRecordSQL

public void setCreateUpdateRecordSQL(@Nonnull @NotEmpty
 String what)

Set the SQL to update an expired record as part of a create (transactional with preCreateQuerySQL.

Parameters:

what - the SQL to set.

setReadRecordSQL

public void setReadRecordSQL(@Nonnull @NotEmpty
 String what)

Set the SQL to read a single record.

Parameters:

what - what to set.

setPreUpdateQuerySQL

public void setPreUpdateQuerySQL(@Nonnull @NotEmpty
 String what)

Set the SQL to get check whether this record already exists and is unexpired prior to an update.

Parameters:

what - The preUpdateQuerySQL to set.

setUpdateRecordSQL

public void setUpdateRecordSQL(@Nonnull @NotEmpty
 String what)

Set the SQL to update a record. Transactional with preUpdateQuerySQL

Parameters:

what - The updateQuerySQL to set.

setPreDeleteQuerySQL

public void setPreDeleteQuerySQL(@Nonnull @NotEmpty
 String what)

Set the SQL to check whether a record exists prior to deleting it.

Parameters:

what - The SQL to set.

setDeleteRecordSQL

public void setDeleteRecordSQL(String what)

Set the SQL to delete a record. Transactional with preDeleteQuerySQL.

Parameters:

what - The SQL to set.

setDeleteByExpiredSQL

public void setDeleteByExpiredSQL(@Nonnull @NotEmpty
 String what)

Set the SQL to delete expired record. Used as part of the getCleanupTask().

Parameters:

what - The SQL to set.

setDeleteByContextExpiredSQL

public void setDeleteByContextExpiredSQL(@Nonnull @NotEmpty
 String what)

Set the SQL to delete expired record with specified context. Used as part of reap(String).

Parameters:

what - The SQL to set.

setUpdateExpiresByContextSQL

public void setUpdateExpiresByContextSQL(@Nonnull @NotEmpty
 String what)

Set the SQL to update the expiration of a record specified by context.

Parameters:

what - The SQL to set.

setDeleteByContextSQL

public void setDeleteByContextSQL(@Nonnull @NotEmpty
 String what)

Set the SQL to Delete a specified Context.

Parameters:

what - The SQL to set.

setGetContextKeysSQL

public void setGetContextKeysSQL(@Nonnull @NotEmpty
 String what)

Set the SQL to fetch the keys in a specified context.

Parameters:

what - the SQL to set

Since:

2.0.0

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractStorageService

Throws:

ComponentInitializationException

readContexts

@Nonnull
@NonnullElements
protected List<String> readContexts()
                             throws IOException

Returns all contexts from the store (for testing only).

Returns:

all contexts or an empty list

Throws:

IOException - if errors occur in the read process

readAll

@Nonnull
@NonnullElements
protected List<?> readAll()
                   throws IOException

Returns all records from the store (for testing only).

Returns:

all records or an empty list

Throws:

IOException - if errors occur in the read process

readAll

@Nonnull
@NonnullElements
protected List<?> readAll(@Nonnull @NotEmpty
 String context)
                   throws IOException

Returns all records from the store for the supplied context (for testing only).

Parameters:

context - a storage context label

Returns:

all records in the context or an empty list

Throws:

IOException - if errors occur in the read process

create

public boolean create(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Nonnull @NotEmpty
 String value,
 @Nullable @Positive
 Long expiration)
               throws IOException

Specified by:

create in interface StorageService

Throws:

IOException

read

@Nullable
public <T> StorageRecord<T> read(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key)
                          throws IOException

Specified by:

read in interface StorageService

Throws:

IOException

read

@Nonnull
public <T> Pair<Long,StorageRecord<T>> read(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Positive
 long version)
                                     throws IOException

Specified by:

read in interface StorageService

Throws:

IOException

readImpl

@Nonnull
protected <T> Pair<Long,StorageRecord<T>> readImpl(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Positive @Nullable
 Long version)
                                            throws IOException

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

Type Parameters:

T - type of object

Parameters:

context - to search for

key - to search for

version - to match

Returns:

pair of version and storage record

Throws:

IOException - if errors occur in the read process

update

public boolean update(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Nonnull @NotEmpty
 String value,
 @Nullable @Positive
 Long expiration)
               throws IOException

Specified by:

update in interface StorageService

Throws:

IOException

updateWithVersion

@Nullable
public Long updateWithVersion(@Positive
 long version,
 @Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Nonnull @NotEmpty
 String value,
 @Nullable @Positive
 Long expiration)
                       throws IOException,
VersionMismatchException

Specified by:

updateWithVersion in interface StorageService

Throws:

IOException

VersionMismatchException

updateExpiration

public boolean updateExpiration(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Nullable @Positive
 Long expiration)
                         throws IOException

Specified by:

updateExpiration in interface StorageService

Throws:

IOException

updateImpl

@Nullable
protected Long updateImpl(@Nullable
 Long version,
 @Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Nullable
 String value,
 @Nullable @Positive
 Long expires)
                   throws 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

expires - to update

Returns:

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

Throws:

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
 String context,
 @Nonnull @NotEmpty
 String key)
                          throws IOException,
VersionMismatchException

Specified by:

deleteWithVersion in interface StorageService

Throws:

IOException

VersionMismatchException

delete

public boolean delete(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key)
               throws IOException

Specified by:

delete in interface StorageService

Throws:

IOException

deleteImpl

protected boolean deleteImpl(@Nullable @Positive
 Long version,
 @Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key)
                      throws 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:

IOException - if errors occur in the delete process

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

deleteImpl

protected void deleteImpl(@Nonnull
 Long expiration)
                   throws IOException

Deletes every record with an expiration before the supplied expiration.

Parameters:

expiration - of records to delete

Throws:

IOException - if errors occur in the cleanup process

reap

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

Specified by:

reap in interface StorageService

Throws:

IOException

updateContextExpiration

public void updateContextExpiration(@Nonnull @NotEmpty
 String context,
 @Nullable
 Long expires)
                             throws IOException

Specified by:

updateContextExpiration in interface StorageService

Throws:

IOException

deleteContext

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

Specified by:

deleteContext in interface StorageService

Throws:

IOException

getContextKeys

@Nonnull
public Iterable<String> getContextKeys(@Nonnull @NotEmpty
 String context,
 @Nullable
 String prefix)
                                throws IOException

Specified by:

getContextKeys in interface EnumeratableStorageService

Throws:

IOException

verifyDatabase

private void verifyDatabase()
                     throws IOException,
ComponentInitializationException

Check the database and the presence of a uniqueness constraint. - Create a record and give it 10 minutes life - Read it back - Delete it

Throws:

IOException - if our methods fail

ComponentInitializationException - if no record was inserted or the wrong value came back

getExpires

@Nullable
private static Long getExpires(@Nonnull
 ResultSet results,
 int columm)
                        throws SQLException

Return the value of expires in the supplied column of the supplied ResultSet.

Parameters:

results - the results whose current row we want to inspect

columm - the column

Returns:

the expiration (converting an SQL null into a null)

Throws:

SQLException - if the results interrogation fails

setExpires

private static void setExpires(@Nonnull
 PreparedStatement stmnt,
 int column,
 @Nullable
 Long expires)
                        throws SQLException

Set the value of expiration into the prepared statement at the suppiled column converting java nulls into SQL nulls.

Parameters:

stmnt - where to put it

column - which column to put it in

expires - what to set it to

Throws:

SQLException - if the PreparedStatement throws one.

isServerSide

public boolean isServerSide()

Specified by:

isServerSide in interface StorageCapabilities

isClustered

public boolean isClustered()

Specified by:

isClustered in interface StorageCapabilities

getCleanupTask

@Nullable
protected TimerTask getCleanupTask()

Overrides:

getCleanupTask in class AbstractStorageService