org.cristalise.kernel.entity.proxy

Class AgentProxy

java.lang.Object

org.cristalise.kernel.entity.proxy.ItemProxy

org.cristalise.kernel.entity.proxy.AgentProxy

public class AgentProxy
extends ItemProxy

It is a wrapper for the connection and communication with Agent It caches data loaded from the Agent to reduce communication

Field Summary

Fields inherited from class org.cristalise.kernel.entity.proxy.ItemProxy

mIOR, mItem, mItemPath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AgentProxy(Object ior, AgentPath agentPath) Creates an AgentProxy without cache and change notification

Method Summary

Modifier and Type	Method and Description
String	execute(ItemProxy item, String predefStep, C2KLocalObject obj)
String	execute(ItemProxy item, String predefStep, String param) Single parameter execution.
String	execute(ItemProxy item, String predefStep, String[] params) Multi-parameter execution.
String	execute(Job job) Standard execution of jobs.
void	finalize() If this is reaped, clear out the cache for it too.
Authenticator	getAuthObj()
ItemProxy	getItem(Path itemPath)
ItemProxy	getItem(String itemPath)
ItemProxy	getItemByUUID(String uuid)
AgentPath	getPath()
String	marshall(Object obj) Wrappers for scripts
Agent	narrow()
ItemProxy	searchItem(Path root, String name) Let scripts resolve items
ItemProxy	searchItem(String name)
List<ItemProxy>	searchItems(Path start, Property[] props)
List<ItemProxy>	searchItems(Path start, PropertyDescriptionList props)
void	setAuthObj(Authenticator auth)
Object	unmarshall(String obj)

Methods inherited from class org.cristalise.kernel.entity.proxy.ItemProxy

checkContent, checkViewpoint, dumpSubscriptions, executeQuery, getCollection, getCollection, getCollection, getCollection, getContents, getItem, getJobByName, getJobByTransitionName, getJobByTransitionName, getJobList, getName, getObject, getProperty, getProperty, getViewpoint, getWorkflow, initialise, notify, queryData, requestAction, setProperty, subscribe, unsubscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentProxy

protected AgentProxy(Object ior,
                     AgentPath agentPath)
              throws ObjectNotFoundException

Creates an AgentProxy without cache and change notification

Throws:

ObjectNotFoundException

Method Detail

finalize

public void finalize()
              throws Throwable

Description copied from class: ItemProxy

If this is reaped, clear out the cache for it too.

Overrides:

finalize in class ItemProxy

Throws:

Throwable

getAuthObj

public Authenticator getAuthObj()

setAuthObj

public void setAuthObj(Authenticator auth)

narrow

public Agent narrow()
             throws ObjectNotFoundException

Overrides:

narrow in class ItemProxy

Throws:

ObjectNotFoundException

execute

public String execute(Job job)
               throws AccessRightsException,
                      InvalidDataException,
                      InvalidTransitionException,
                      ObjectNotFoundException,
                      PersistencyException,
                      ObjectAlreadyExistsException,
                      ScriptErrorException,
                      InvalidCollectionModification

Standard execution of jobs. Note that this method should always be the one used from clients. All execution parameters are taken from the job where they're probably going to be correct.

Parameters:

job - the Actual Job to be executed

Returns:

The outcome after processing. May have been altered by the step.

Throws:

AccessRightsException - The agent was not allowed to execute this step

InvalidDataException - The parameters supplied were incorrect

InvalidTransitionException - The step wasn't available

ObjectNotFoundException - Thrown by some steps that try to locate additional objects

PersistencyException - Problem writing or reading the database

ObjectAlreadyExistsException - Thrown by steps that create additional object

ScriptErrorException - Thrown by scripting classes

InvalidCollectionModification - Thrown by steps that create/modify collections

execute

public String execute(ItemProxy item,
                      String predefStep,
                      C2KLocalObject obj)
               throws AccessRightsException,
                      InvalidDataException,
                      InvalidTransitionException,
                      ObjectNotFoundException,
                      PersistencyException,
                      ObjectAlreadyExistsException,
                      InvalidCollectionModification

Throws:

AccessRightsException

InvalidDataException

InvalidTransitionException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

InvalidCollectionModification

execute

public String execute(ItemProxy item,
                      String predefStep,
                      String[] params)
               throws AccessRightsException,
                      InvalidDataException,
                      InvalidTransitionException,
                      ObjectNotFoundException,
                      PersistencyException,
                      ObjectAlreadyExistsException,
                      InvalidCollectionModification

Multi-parameter execution. Wraps parameters up in a PredefinedStepOutcome if the schema of the requested step is such.

Parameters:

item - The item on which to execute the step

predefStep - The step name to run

params - An array of parameters to pass to the step. See each step's documentation for its required parameters

Returns:

The outcome after processing. May have been altered by the step.

Throws:

AccessRightsException - The agent was not allowed to execute this step

InvalidDataException - The parameters supplied were incorrect

InvalidTransitionException - The step wasn't available

ObjectNotFoundException - Thrown by some steps that try to locate additional objects

PersistencyException - Problem writing or reading the database

ObjectAlreadyExistsException - Thrown by steps that create additional object

InvalidCollectionModification - Thrown by steps that create/modify collections

execute

public String execute(ItemProxy item,
                      String predefStep,
                      String param)
               throws AccessRightsException,
                      InvalidDataException,
                      InvalidTransitionException,
                      ObjectNotFoundException,
                      PersistencyException,
                      ObjectAlreadyExistsException,
                      InvalidCollectionModification

Single parameter execution. Wraps parameters up in a PredefinedStepOutcome if the schema of the requested step is such.

Throws:

AccessRightsException

InvalidDataException

InvalidTransitionException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

InvalidCollectionModification

See Also:

execute(ItemProxy, String, String[])

marshall

public String marshall(Object obj)
                throws Exception

Wrappers for scripts

Throws:

Exception

unmarshall

public Object unmarshall(String obj)
                  throws Exception

Throws:

Exception

searchItem

public ItemProxy searchItem(String name)
                     throws ObjectNotFoundException

Throws:

ObjectNotFoundException

searchItem

public ItemProxy searchItem(Path root,
                            String name)
                     throws ObjectNotFoundException

Let scripts resolve items

Throws:

ObjectNotFoundException

searchItems

public List<ItemProxy> searchItems(Path start,
                                   PropertyDescriptionList props)

searchItems

public List<ItemProxy> searchItems(Path start,
                                   Property[] props)

getItem

public ItemProxy getItem(String itemPath)
                  throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getPath

public AgentPath getPath()

Overrides:

getPath in class ItemProxy

getItem

public ItemProxy getItem(Path itemPath)
                  throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getItemByUUID

public ItemProxy getItemByUUID(String uuid)
                        throws ObjectNotFoundException,
                               InvalidItemPathException

Throws:

ObjectNotFoundException

InvalidItemPathException