com.adaptris.util.datastore

Class SimpleDataStore

java.lang.Object

com.adaptris.util.datastore.DataStore

com.adaptris.util.datastore.SimpleDataStore

public class SimpleDataStore
extends DataStore

SimpleDataStore.

A simple concrete implementation of the datastore class.

The Datastore, takes a number of properties which determines its behaviour, these are:-

 
  #The Fully qualified filename where data will be stored.
  simpledatastore.fileName
  #The Fully qualified filename where a semaphore lock file will be stored.
  simpledatastore.lockFile
  #The number of attempts made to get a lock before an error is thrown
  simpledatastore.maxLockAttempts
 
 

See Also:

DataStore

In the adapter configuration file this class is aliased as simple-data-store which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FILENAME The default data filename.
static java.lang.String	DEFAULT_LOCK The default lock file.
static java.lang.String	FILE_PROPERTY The filename property
static java.lang.String	LOCK_PROPERTY The locfile property
static java.lang.String	MAXLOCK_PROPERTY the max lock attempts property

Fields inherited from class com.adaptris.util.datastore.DataStore

logR

Constructor Summary

Constructors

Constructor and Description
SimpleDataStore()
SimpleDataStore(java.util.Properties p) Constructor using a set of properties.

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String id, java.lang.String type) Check if the data exists in the store.
java.lang.String	getDataFile() Get the data filename.
void	getLock() Get a lock on the file
java.lang.String	getLockFile() Get the lock file name.
int	getMaxAttempts() Return the number of attempts to gain a lock
void	persist(java.lang.String id, java.lang.String type, java.lang.Object obj) Persist the data to the store.
void	remove(java.lang.String id, java.lang.String type) Remove the data from the datastore.
void	removeLock() Remove the lock.
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.
void	setDataFile(java.lang.String string) The Data file stored url format.
void	setLockFile(java.lang.String string) The lock file in url format.
void	setMaxAttempts(int i) Set the number of attempts to gain a lock.

Methods inherited from class com.adaptris.util.datastore.DataStore

getConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

FILE_PROPERTY

public static final java.lang.String FILE_PROPERTY

The filename property

See Also:

Constant Field Values

LOCK_PROPERTY

public static final java.lang.String LOCK_PROPERTY

The locfile property

See Also:

Constant Field Values

MAXLOCK_PROPERTY

public static final java.lang.String MAXLOCK_PROPERTY

the max lock attempts property

See Also:

Constant Field Values

DEFAULT_FILENAME

public static final java.lang.String DEFAULT_FILENAME

The default data filename.

See Also:

Constant Field Values

DEFAULT_LOCK

public static final java.lang.String DEFAULT_LOCK

The default lock file.

See Also:

Constant Field Values

Constructor Detail

SimpleDataStore

public SimpleDataStore()

See Also:

DataStore()

SimpleDataStore

public SimpleDataStore(java.util.Properties p)
                throws DataStoreException

Constructor using a set of properties.

Parameters:

p - the properties.

Throws:

DataStoreException - if there is an error.

See Also:

FILE_PROPERTY, LOCK_PROPERTY, MAXLOCK_PROPERTY

Method Detail

persist

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

Description copied from class: DataStore

Persist the data to the store.

Specified by:

persist in class DataStore

Parameters:

id - the id

type - the type

obj - object stored in the datastore

Throws:

DataStoreException - if an error is encountered

See Also:

DataStore.persist(String, String, Object)

retrieve

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

Description copied from class: DataStore

Retrieve the data from the datastore.

Specified by:

retrieve in class DataStore

Parameters:

id - the id

type - the type

Returns:

the object stored in the datastore

Throws:

DataStoreException - if an error is encountered

See Also:

DataStore.retrieve(String, String)

remove

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

Description copied from class: DataStore

Remove the data from the datastore.

Specified by:

remove in class DataStore

Parameters:

id - the id

type - the type

Throws:

DataStoreException - if an error is encountered

See Also:

DataStore.remove(String, String)

exists

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

Description copied from class: DataStore

Check if the data exists in the store.

Specified by:

exists in class DataStore

Parameters:

id - the id

type - the type

Returns:

true if the data exists

Throws:

DataStoreException - if an error is encountered

See Also:

DataStore.exists(String, String)

getLock

public void getLock()
             throws java.lang.Exception

Get a lock on the file

Throws:

java.lang.Exception - if we could not get the lock.

removeLock

public void removeLock()

Remove the lock.

setDataFile

public void setDataFile(java.lang.String string)

The Data file stored url format.

Parameters:

string - the data file.

getDataFile

public java.lang.String getDataFile()

Get the data filename.

Returns:

the filename in url format.

setLockFile

public void setLockFile(java.lang.String string)

The lock file in url format.

Parameters:

string - the lock file

getLockFile

public java.lang.String getLockFile()

Get the lock file name.

Returns:

the lock file in URL format.

setMaxAttempts

public void setMaxAttempts(int i)

Set the number of attempts to gain a lock.

Parameters:

i - the number of attempts, default is 15.

getMaxAttempts

public int getMaxAttempts()

Return the number of attempts to gain a lock

Returns:

the number of attempts.

setConfiguration

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

Description copied from class: DataStore

Set the configuration for this datastore.

Overrides:

setConfiguration in class DataStore

Parameters:

p - the configuration

Throws:

DataStoreException - if there was an error.

See Also:

DataStore.setConfiguration(java.util.Properties)