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) Initialises 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 locker)
void	begin(Object locker)
void	clearCache()
void	clearCache(ItemPath itemPath)
void	clearCache(ItemPath itemPath, String path)
void	close()
void	commit(Object locker)
void	dumpCacheContents(int logLevel)
String	executeQuery(Query query) Executes the Query
C2KLocalObject	get(ItemPath itemPath, String path) Internal get method.
String[]	getClusterContents(ItemPath itemPath, String path) Retrieves the ids of the next level of a cluster Does not look in any currently open transactions.
ArrayList<ClusterStorage>	instantiateStores(String allClusters)
void	postBoostrap()
void	postConnect()
void	postStartServer()
void	put(ItemPath itemPath, C2KLocalObject obj)
void	put(ItemPath itemPath, C2KLocalObject obj, Object locker) Internal put method.
void	remove(ItemPath itemPath, String path)
void	remove(ItemPath itemPath, String path, Object locker) Deletes a cluster from 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

Initialises 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

Throws:

PersistencyException

close

public void close()

executeQuery

public String executeQuery(Query query)
                    throws PersistencyException

Executes the Query

Parameters:

query - the Query to be executed

Returns:

the xml result of the query

Throws:

PersistencyException

getClusterContents

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

Retrieves the ids of the next level of a cluster Does not look in any currently open transactions.

Parameters:

itemPath - the current Item

path - the cluster path

Returns:

list of keys found in the cluster

Throws:

PersistencyException

get

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

Internal get method. 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 Iten

path - the cluster path

Returns:

the C2KObject located by path

Throws:

PersistencyException

ObjectNotFoundException

put

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

Throws:

PersistencyException

put

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

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

Throws:

PersistencyException

remove

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

Throws:

PersistencyException

remove

public void remove(ItemPath itemPath,
                   String path,
                   Object locker)
            throws PersistencyException

Deletes a cluster from all writers

Throws:

PersistencyException

clearCache

public void clearCache(ItemPath itemPath,
                       String path)

clearCache

public void clearCache(ItemPath itemPath)

clearCache

public void clearCache()

dumpCacheContents

public void dumpCacheContents(int logLevel)

begin

public void begin(Object locker)
           throws PersistencyException

Throws:

PersistencyException

commit

public void commit(Object locker)
            throws PersistencyException

Throws:

PersistencyException

abort

public void abort(Object locker)
           throws PersistencyException

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