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, use 'Storage.disableCache=true' to disable it.

Constructor Summary

Constructors

Constructor and Description
ClusterStorageManager(Authenticator auth) 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 and Description
void	abort(Object transactionKey)
void	begin(Object transactionKey)
void	clearCache() Clear entire cache
void	clearCache(ItemPath itemPath) Clear the cache of the given Item.
void	clearCache(ItemPath itemPath, String path) Clear the cache of the given cluster content of the given Item.
void	close()
void	commit(Object transactionKey)
void	dumpCacheContents() Print the content of the cache to the log
String	executeQuery(Query query)
String	executeQuery(Query query, Object transactionKey) Executes the Query
C2KLocalObject	get(ItemPath itemPath, String path)
C2KLocalObject	get(ItemPath itemPath, String path, Object transactionKey) Retrieves clusters from ClusterStorages & maintains the memory cache.
String[]	getClusterContents(ItemPath itemPath, ClusterType type)
String[]	getClusterContents(ItemPath itemPath, ClusterType type, Object transactionKey)
String[]	getClusterContents(ItemPath itemPath, String path)
String[]	getClusterContents(ItemPath itemPath, String path, Object transactionKey) Retrieves the ids of the next level of a cluster.
int	getLastIntegerId(ItemPath itemPath, String path, Object 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)
void	put(ItemPath itemPath, C2KLocalObject obj, Object transactionKey) Creates or overwrites a cluster in all writers.
void	remove(ItemPath itemPath, String path) Deletes a cluster from all writers
void	remove(ItemPath itemPath, String path, Object transactionKey) Deletes a cluster from all writers
void	removeCluster(ItemPath itemPath, String path, Object transactionKey) Removes all child objects from the given path for all writers

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterStorageManager

public ClusterStorageManager(Authenticator auth)
                      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.

Parameters:

auth - the Authenticator to be used to initialise all the handlers

Throws:

PersistencyException

Method Detail

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,
                           Object transactionKey)
                    throws PersistencyException

Executes the Query

Parameters:

query - the Query to be executed

query -

transactionKey -

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,
                                   Object 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,
                                   Object 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,
                          Object transactionKey)
                   throws PersistencyException,
                          ObjectNotFoundException

Retrieves clusters from ClusterStorages & maintains the memory cache.
There is a special case for Viewpoint. When path ends with /data it returns referenced Outcome instead of Viewpoint.

Parameters:

itemPath - current Item

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

Returns:

the C2KObject located by path

Throws:

PersistencyException

ObjectNotFoundException

getLastIntegerId

public int getLastIntegerId(ItemPath itemPath,
                            String path,
                            Object 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:

Throws:

PersistencyException

put

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

Parameters:

itemPath -

obj -

Throws:

PersistencyException

put

public void put(ItemPath itemPath,
                C2KLocalObject obj,
                Object 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)
            throws PersistencyException

Deletes a cluster from all writers

Parameters:

itemPath - - Item to delete from

path - - root path to delete

Throws:

PersistencyException - - when deleting fails

remove

public void remove(ItemPath itemPath,
                   String path,
                   Object 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,
                          String path,
                          Object 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 void clearCache(ItemPath itemPath,
                       String path)

Clear the cache of the given cluster content of the given Item. If itemPath is null clear the entire cache. If path is empty clear the cache of the given Item.

Parameters:

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

path - the identifier of the cluster content to be cleared. Can be null.

clearCache

public void clearCache(ItemPath itemPath)

Clear the cache of the given Item. If itemPath is null clear the entire cache.

Parameters:

itemPath - the Item for which the cache should be cleared. Can be null.

clearCache

public void clearCache()

Clear entire cache

dumpCacheContents

public void dumpCacheContents()

Print the content of the cache to the log

begin

public void begin(Object transactionKey)
           throws PersistencyException

Parameters:

transactionKey -

Throws:

PersistencyException

commit

public void commit(Object transactionKey)
            throws PersistencyException

Parameters:

transactionKey -

Throws:

PersistencyException

abort

public void abort(Object 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