com.adaptris.util.datastore

Class DataStore

java.lang.Object

com.adaptris.util.datastore.DataStore

Direct Known Subclasses:

SimpleDataStore

public abstract class DataStore
extends java.lang.Object

DataStore abstract class.

This is a simple interface for persisting data. The underlying implementation is reponsible for handling stuff like locks and other stuff

An object within the datastore is considered to be uniquely defined by its "id" and "type".

See Also:

SimpleDataStore

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logR

Constructor Summary

Constructors

Constructor and Description
DataStore()

Method Summary

Modifier and Type	Method and Description
abstract boolean	exists(java.lang.String id, java.lang.String type) Check if the data exists in the store.
java.util.Properties	getConfiguration() Get the configuration for this datastore.
abstract void	persist(java.lang.String id, java.lang.String type, java.lang.Object obj) Persist the data to the store.
abstract void	remove(java.lang.String id, java.lang.String type) Remove the data from the datastore.
abstract java.lang.Object	retrieve(java.lang.String id, java.lang.String type) Retrieve the data from the datastore.
void	setConfiguration(java.util.Properties p) Set the configuration for this datastore.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logR

protected transient org.slf4j.Logger logR

Constructor Detail

DataStore

public DataStore()

See Also:

Object.Object()

Method Detail

setConfiguration

public void setConfiguration(java.util.Properties p)
                      throws DataStoreException

Set the configuration for this datastore.

Parameters:

p - the configuration

Throws:

DataStoreException - if there was an error.

getConfiguration

public java.util.Properties getConfiguration()

Get the configuration for this datastore.

Returns:

the configuration

persist

public abstract void persist(java.lang.String id,
                             java.lang.String type,
                             java.lang.Object obj)
                      throws DataStoreException

Persist the data to the store.

Parameters:

id - the id

type - the type

obj - object stored in the datastore

Throws:

DataStoreException - if an error is encountered

retrieve

public abstract java.lang.Object retrieve(java.lang.String id,
                                          java.lang.String type)
                                   throws DataStoreException

Retrieve the data from the datastore.

Parameters:

id - the id

type - the type

Returns:

the object stored in the datastore

Throws:

DataStoreException - if an error is encountered

remove

public abstract void remove(java.lang.String id,
                            java.lang.String type)
                     throws DataStoreException

Remove the data from the datastore.

Parameters:

id - the id

type - the type

Throws:

DataStoreException - if an error is encountered

exists

public abstract boolean exists(java.lang.String id,
                               java.lang.String type)
                        throws DataStoreException

Check if the data exists in the store.

Parameters:

id - the id

type - the type

Returns:

true if the data exists

Throws:

DataStoreException - if an error is encountered