org.cristalise.storage

Class ProxyLoader

java.lang.Object

org.cristalise.kernel.persistency.ClusterStorage

org.cristalise.storage.ProxyLoader

public class ProxyLoader
extends ClusterStorage

Used by proxies to load clusters by queryData from the Entity. Last client storage - only used if not cached elsewhere

Field Summary

Fields inherited from class org.cristalise.kernel.persistency.ClusterStorage

allClusterTypes, COLLECTION, HISTORY, JOB, LIFECYCLE, NONE, OUTCOME, PROPERTY, READ, READWRITE, ROOT, VIEWPOINT, WRITE

Constructor Summary

Constructors

Constructor and Description
ProxyLoader()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Shuts down the storage.
void	delete(ItemPath thisItem, String path) Remove a CRISTAL local object from storage.
C2KLocalObject	get(ItemPath thisItem, String path) Fetches a CRISTAL local object from storage
String[]	getClusterContents(ItemPath thisItem, String path) Queries the local path below the given root and returns the possible next elements.
String	getId()
String	getName()
void	open(Authenticator auth) Connects to the storage.
void	put(ItemPath thisItem, C2KLocalObject obj) Stores a CRISTAL local object.
short	queryClusterSupport(String clusterType) Declares whether or not this ClusterStorage can read or write a particular CRISTAL local object type.

Methods inherited from class org.cristalise.kernel.persistency.ClusterStorage

getClusterType, getPath

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyLoader

public ProxyLoader()

Method Detail

open

public void open(Authenticator auth)
          throws PersistencyException

Description copied from class: ClusterStorage

Connects to the storage. It must be possible to retrieve CRISTAL local objects after this method returns.

Specified by:

open in class ClusterStorage

Parameters:

auth - The Authenticator instance that the user or server logged in with.

Throws:

PersistencyException - If storage initialization failed

close

public void close()
           throws PersistencyException

Description copied from class: ClusterStorage

Shuts down the storage. Data must be completely written to disk before this method returns, so the process can exit. No further gets or puts should follow.

Specified by:

close in class ClusterStorage

Throws:

PersistencyException - If closing failed

queryClusterSupport

public short queryClusterSupport(String clusterType)

Description copied from class: ClusterStorage

Declares whether or not this ClusterStorage can read or write a particular CRISTAL local object type.

Specified by:

queryClusterSupport in class ClusterStorage

Parameters:

clusterType - The Cluster type requested. Must be one of the Cluster type constants from this class.

Returns:

A ClusterStorage constant: NONE, READ, WRITE, or READWRITE

getName

public String getName()

Specified by:

getName in class ClusterStorage

Returns:

A full name of this storage for logging

getId

public String getId()

Specified by:

getId in class ClusterStorage

Returns:

A short code for this storage for reference

get

public C2KLocalObject get(ItemPath thisItem,
                 String path)
                   throws PersistencyException

Description copied from class: ClusterStorage

Fetches a CRISTAL local object from storage

Specified by:

get in class ClusterStorage

Parameters:

thisItem - The ItemPath of the containing Item

path - The path of the local object

Returns:

The C2KLocalObject, or null if the object was not found

Throws:

PersistencyException - when retrieval failed

put

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

Description copied from class: ClusterStorage

Stores a CRISTAL local object. The path is automatically generated.

Specified by:

put in class ClusterStorage

Parameters:

thisItem - The Item that the object will be stored under

obj - The C2KLocalObject to store

Throws:

PersistencyException - When storage fails

delete

public void delete(ItemPath thisItem,
          String path)
            throws PersistencyException

Description copied from class: ClusterStorage

Remove a CRISTAL local object from storage. This should be used sparingly and responsibly, as it violated traceability. Objects removed in this way are not expected to be recoverable.

Specified by:

delete in class ClusterStorage

Parameters:

thisItem - The containing Item

path - The path of the object to be removed

Throws:

PersistencyException - When deletion fails or is not allowed

getClusterContents

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

Description copied from class: ClusterStorage

Queries the local path below the given root and returns the possible next elements.

Specified by:

getClusterContents in class ClusterStorage

Parameters:

thisItem - The Item to query

path - The path within that Item to query. May be ClusterStorage.ROOT (empty String)

Returns:

A String array of the possible next path elements

Throws:

PersistencyException - When an error occurred during the query