Package org.cristalise.kernel.entity.proxy

Class AgentProxy

java.lang.Object

org.cristalise.kernel.entity.proxy.ItemProxy

org.cristalise.kernel.entity.proxy.AgentProxy

@Immutable
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

mItem, mItemPath, transactionKey

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	execute(Job job)	Standard execution of jobs.
String	execute(Job job, Job errorJob)	Extended execution of jobs when the client knows that there is a Transition to be used in case of an error.
String	execute(ItemProxy item, Class<?> predefStep)	Execution without any parameters using Class of predefined step instead of string literal.
String	execute(ItemProxy item, Class<?> predefStep, String param)	Single parameter execution using Class of predefined step instead of string literal.
String	execute(ItemProxy item, Class<?> predefStep, String... params)
String	execute(ItemProxy item, Class<?> predefStep, C2KLocalObject obj)
String	execute(ItemProxy item, String predefStep)	Execution without any parameters.
String	execute(ItemProxy item, String predefStep, String param)	Single parameter execution.
String	execute(ItemProxy item, String predefStep, String... params)	Multi-parameter execution.
String	execute(ItemProxy item, String predefStep, C2KLocalObject obj)
ItemProxy	getItem(String itemPath)
ItemProxy	getItem(Path itemPath)
ItemProxy	getItemByUUID(String uuid)
AgentPath	getPath()	Return the ItemPath object of the Item this proxy is linked with
RolePath[]	getRoles()
ItemProxy	searchItem(String name)
ItemProxy	searchItem(Path root, String name)	Let scripts resolve items
List<ItemProxy>	searchItems(Path start, Property[] props)
List<ItemProxy>	searchItems(Path start, PropertyDescriptionList props)

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

checkCollection, checkCollection, checkCollection, checkCollection, checkContent, checkContent, checkContent, checkContent, checkJobForAgent, checkOutcome, checkOutcome, checkOutcome, checkOutcome, checkOutcomeAttachment, checkOutcomeAttachment, checkProperty, checkProperty, checkProperty, checkProperty, checkViewpoint, checkViewpoint, clearCache, executeQuery, getAggregateScript, getAggregateScript, getCollection, getCollection, getCollection, getCollection, getCollection, getCollection, getCollection, getCollection, getContents, getContents, getContents, getContents, getEvent, getEvent, getHistory, getHistory, getItem, getJob, getJob, getJobByName, getJobByTransitionName, getJobByTransitionName, getJobs, getJobs, getJobs, getJobs, getJobs, getMasterSchema, getMasterSchema, getName, getName, getObject, getObject, getObject, getObject, getOutcome, getOutcome, getOutcome, getOutcome, getOutcome, getOutcome, getOutcome, getOutcome, getOutcomeAttachment, getOutcomeAttachment, getOutcomeAttachment, getOutcomeAttachment, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getType, getType, getUpdateSchema, getUuid, getViewpoint, getViewpoint, getViewpoints, getViewpoints, getWorkflow, getWorkflow, marshall, queryData, queryData, requestAction, requestAction, setProperty, toString, unmarshall

Methods inherited from class java.lang.Object

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

Constructor Details

AgentProxy

protected AgentProxy(AgentPath agentPath)
              throws ObjectNotFoundException

Creates an AgentProxy without cache and change notification

Parameters:

agentPath -

ior -

Throws:

ObjectNotFoundException

AgentProxy

protected AgentProxy(AgentPath agentPath,
 TransactionKey transKey)

Method Details

execute

public String execute(Job job,
 Job errorJob)
               throws CriseVertxException

Extended execution of jobs when the client knows that there is a Transition to be used in case of an error. All execution parameters are taken from the job where they're probably going to be correct.

Parameters:

job - the Actual Job to be executed

errorJob - the Job the be executed in case there was an exception while executing the original Job. The client calling this method knows (configured) which Job is need to be used.

Returns:

The outcome after processing. May have been altered by the step. Aternatively it contains the xml of marshalles ErrorInfo if the errorJob was exeuted

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

CriseVertxException

execute

public String execute(Job job)
               throws CriseVertxException

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:

CriseVertxException

execute

public String execute(ItemProxy item,
 Class<?> predefStep,
 C2KLocalObject obj)
               throws CriseVertxException

Parameters:

item -

predefStep -

obj -

Returns:

Throws:

AccessRightsException

InvalidDataException

InvalidTransitionException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

InvalidCollectionModification

CriseVertxException

execute

public String execute(ItemProxy item,
 String predefStep,
 C2KLocalObject obj)
               throws CriseVertxException

Parameters:

item -

predefStep -

obj -

Returns:

Throws:

AccessRightsException

InvalidDataException

InvalidTransitionException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

InvalidCollectionModification

CriseVertxException

execute

public String execute(ItemProxy item,
 Class<?> predefStep,
 String... params)
               throws CriseVertxException

Parameters:

item -

predefStep -

params -

Returns:

Throws:

AccessRightsException

InvalidDataException

InvalidTransitionException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

InvalidCollectionModification

CriseVertxException

execute

public String execute(ItemProxy item,
 String predefStep,
 String... params)
               throws CriseVertxException

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

CriseVertxException

execute

public String execute(ItemProxy item,
 Class<?> predefStep)
               throws CriseVertxException

Execution without any parameters using Class of predefined step instead of string literal. There are steps which can be executed without any parameters

Throws:

CriseVertxException

See Also:

• execute(ItemProxy, String)

execute

public String execute(ItemProxy item,
 String predefStep)
               throws CriseVertxException

Execution without any parameters. There are steps which can be executed without any parameters

Throws:

CriseVertxException

See Also:

• execute(ItemProxy, String, String[])

execute

public String execute(ItemProxy item,
 Class<?> predefStep,
 String param)
               throws CriseVertxException

Single parameter execution using Class of predefined step instead of string literal. Wraps parameters up in a PredefinedStepOutcome if the schema of the requested step is such.

Throws:

CriseVertxException

See Also:

• execute(ItemProxy, String, String)

execute

public String execute(ItemProxy item,
 String predefStep,
 String param)
               throws CriseVertxException

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

Throws:

CriseVertxException

See Also:

• execute(ItemProxy, String, String[])

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()

Description copied from class: ItemProxy

Return the ItemPath object of the Item this proxy is linked with

Overrides:

getPath in class ItemProxy

Returns:

the ItemPath of the Item

getItem

public ItemProxy getItem(Path itemPath)
                  throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getItemByUUID

public ItemProxy getItemByUUID(String uuid)
                        throws ObjectNotFoundException,
InvalidItemPathException

Throws:

ObjectNotFoundException

InvalidItemPathException

getRoles

public RolePath[] getRoles()