Package org.cristalise.kernel.persistency

Class ClusterStorageManager

java.lang.Object

org.cristalise.kernel.persistency.ClusterStorageManager

public class ClusterStorageManager
extends Object

Instantiates ClusterStorages listed in properties file. All read/write requests to storage pass through this object, which can query the capabilities of each declared storage, and channel requests accordingly. Transaction based. It also has a memoryCache to increase performance..

Constructor Summary

Constructors

Constructor	Description
ClusterStorageManager()	Initializes all ClusterStorage handlers listed by class name in the property "ClusterStorages" This property is usually process specific, and so should be in the server/client.conf and not the connect file.

Method Summary

Modifier and Type	Method	Description
void	abort(TransactionKey transactionKey)
void	begin(TransactionKey transactionKey)
long	clearCache()	Clear entire cache
long	clearCache(String pattern)
long	clearCache(List<String> fullPathList)
long	clearCache(ItemPath itemPath)
long	clearCache(ItemPath itemPath, String path)	Clear the cache of the given cluster content of the given Item.
long	clearCache(ItemPath itemPath, ClusterType cluster)
void	close()
void	commit(TransactionKey transactionKey)
String	executeQuery(Query query)
String	executeQuery(Query query, TransactionKey transactionKey)	Executes the Query
C2KLocalObject	get(ItemPath itemPath, String path)
C2KLocalObject	get(ItemPath itemPath, String path, TransactionKey transactionKey)	Retrieves clusters from ClusterStorages invalid input: '&' maintains the memory cache.
String[]	getClusterContents(ItemPath itemPath, String path)
String[]	getClusterContents(ItemPath itemPath, String path, TransactionKey transactionKey)	Retrieves the ids of the next level of a cluster.
String[]	getClusterContents(ItemPath itemPath, ClusterType type)
String[]	getClusterContents(ItemPath itemPath, ClusterType type, TransactionKey transactionKey)
int	getLastIntegerId(ItemPath itemPath, String path, TransactionKey transactionKey)	Retrieves the last id of the History
ArrayList<ClusterStorage>	instantiateStores(String allClusters)
void	postBoostrap()
void	postConnect()
void	postStartServer()
void	put(ItemPath itemPath, C2KLocalObject obj, TransactionKey transactionKey)	Creates or overwrites a cluster in all writers.
void	remove(ItemPath itemPath, String path, TransactionKey transactionKey)	Deletes a cluster from all writers
void	removeCluster(ItemPath itemPath, String path, TransactionKey transactionKey)	Removes all child objects from the given path for all writers
void	removeCluster(ItemPath itemPath, ClusterType cluster, TransactionKey transactionKey)	Removes all objects of a ClusterType
void	removeCluster(ItemPath itemPath, TransactionKey transactionKey)	Removes all data associated with the item

Methods inherited from class java.lang.Object

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

Constructor Details

ClusterStorageManager

public ClusterStorageManager()
                      throws PersistencyException

Initializes all ClusterStorage handlers listed by class name in the property "ClusterStorages" This property is usually process specific, and so should be in the server/client.conf and not the connect file.

Throws:

PersistencyException

Method Details

instantiateStores

public ArrayList<ClusterStorage> instantiateStores(String allClusters)
                                            throws PersistencyException

Parameters:

allClusters -

Returns:

Throws:

PersistencyException

close

public void close()

executeQuery

public String executeQuery(Query query)
                    throws PersistencyException

Parameters:

query -

Returns:

Throws:

PersistencyException

executeQuery

public String executeQuery(Query query,
 TransactionKey transactionKey)
                    throws PersistencyException

Executes the Query

Parameters:

query - the Query to be executed

transactionKey -

query -

Returns:

the xml result of the query

Throws:

PersistencyException

getClusterContents

public String[] getClusterContents(ItemPath itemPath,
 ClusterType type)
                            throws PersistencyException

Throws:

PersistencyException

getClusterContents

public String[] getClusterContents(ItemPath itemPath,
 ClusterType type,
 TransactionKey transactionKey)
                            throws PersistencyException

Throws:

PersistencyException

getClusterContents

public String[] getClusterContents(ItemPath itemPath,
 String path)
                            throws PersistencyException

Throws:

PersistencyException

getClusterContents

public String[] getClusterContents(ItemPath itemPath,
 String path,
 TransactionKey transactionKey)
                            throws PersistencyException

Retrieves the ids of the next level of a cluster.

Parameters:

itemPath - the current Item

path - the cluster path. The leading slash is removed if exists

Returns:

list of keys found in the cluster

Throws:

PersistencyException

get

public C2KLocalObject get(ItemPath itemPath,
 String path)
                   throws PersistencyException,
ObjectNotFoundException

Parameters:

itemPath -

path -

Returns:

Throws:

PersistencyException

ObjectNotFoundException

get

public C2KLocalObject get(ItemPath itemPath,
 String path,
 TransactionKey transactionKey)
                   throws PersistencyException,
ObjectNotFoundException

Retrieves clusters from ClusterStorages invalid input: '&' maintains the memory cache.

Parameters:

itemPath - current Item

path - the cluster path. The leading slash is removed if exists. Cannot be blank or a single '/'

Returns:

the C2KLocalObject located by path

Throws:

PersistencyException

ObjectNotFoundException

getLastIntegerId

public int getLastIntegerId(ItemPath itemPath,
 String path,
 TransactionKey transactionKey)
                     throws PersistencyException

Retrieves the last id of the History

Parameters:

itemPath - current Item

path - the cluster path. The leading slash is removed if exists

transactionKey -

Returns:

the ID used starting with 0 or -1 if the cluster empty (e.g. Jobs)

Throws:

PersistencyException

put

public void put(ItemPath itemPath,
 C2KLocalObject obj,
 TransactionKey transactionKey)
         throws PersistencyException

Creates or overwrites a cluster in all writers. Used when committing transactions.

Throws:

PersistencyException

remove

public void remove(ItemPath itemPath,
 String path,
 TransactionKey transactionKey)
            throws PersistencyException

Deletes a cluster from all writers

Parameters:

itemPath - - Item to delete from

path - - root path to delete

transactionKey - - locking object

Throws:

PersistencyException - - when deleting fails

removeCluster

public void removeCluster(ItemPath itemPath,
 ClusterType cluster,
 TransactionKey transactionKey)
                   throws PersistencyException

Removes all objects of a ClusterType

Parameters:

itemPath - - Item to delete from

cluster - - the cluster type

transactionKey - - locking object

Throws:

PersistencyException - - when deleting fails

removeCluster

public void removeCluster(ItemPath itemPath,
 TransactionKey transactionKey)
                   throws PersistencyException

Removes all data associated with the item

Parameters:

itemPath - - Item to be deleted

transactionKey - - locking object

Throws:

PersistencyException - - when deleting fails

removeCluster

public void removeCluster(ItemPath itemPath,
 String path,
 TransactionKey transactionKey)
                   throws PersistencyException

Removes all child objects from the given path for all writers

Parameters:

itemPath - - Item to delete from

path - - root path to delete

transactionKey - - locking object

Throws:

PersistencyException - - when deleting fails

clearCache

public long clearCache(ItemPath itemPath,
 ClusterType cluster)

Parameters:

itemPath -

clearCache

public long clearCache(ItemPath itemPath)

Parameters:

itemPath -

clearCache

public long clearCache(String pattern)

Parameters:

pattern -

clearCache

public long clearCache(ItemPath itemPath,
 String path)

Clear the cache of the given cluster content of the given Item.

Parameters:

itemPath - the item for which the cache should be cleared. Cannot be null.

path - the identifier of the cluster content to be cleared. Cannot not be nul.

clearCache

public long clearCache(List<String> fullPathList)

Parameters:

fullPathList -

clearCache

public long clearCache()

Clear entire cache

begin

public void begin(TransactionKey transactionKey)
           throws PersistencyException

Parameters:

transactionKey -

Throws:

PersistencyException

commit

public void commit(TransactionKey transactionKey)
            throws PersistencyException

Parameters:

transactionKey -

Throws:

PersistencyException

abort

public void abort(TransactionKey transactionKey)
           throws PersistencyException

Parameters:

transactionKey -

Throws:

PersistencyException

postConnect

public void postConnect()
                 throws PersistencyException

Throws:

PersistencyException

postBoostrap

public void postBoostrap()
                  throws PersistencyException

Throws:

PersistencyException

postStartServer

public void postStartServer()
                     throws PersistencyException

Throws:

PersistencyException