org.cristalise.kernel.entity.agent

Class AgentImplementation

java.lang.Object

org.cristalise.kernel.entity.ItemImplementation

org.cristalise.kernel.entity.agent.AgentImplementation

All Implemented Interfaces:

AgentOperations, ItemOperations

public class AgentImplementation
extends ItemImplementation
implements AgentOperations

Implementation of Agent, though called from the CORBA implementation ActiveEntity.

The Agent is an extension of the Item that can execute Jobs, and in doing so change the state of Item workflows, submit data to them in the form of Outcomes and run any scripts associated with those activities. In this server object, none of this specific Agent work is performed - it all must be done using the client API. The server implementation only manages the Agent's data: its roles and persistent Jobs.

Field Summary

Fields inherited from class org.cristalise.kernel.entity.ItemImplementation

mItemPath, mStorage

Constructor Summary

Constructors

Constructor and Description
AgentImplementation(AgentPath path)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRole(String roleName) Adds the given Role to this Agent.
protected PredefinedStepContainer	getNewPredefStepContainer() Agents have their own predefined step containers.
void	refreshJobList(SystemKey sysKey, String stepPath, String newJobs) Updates an Agent's list of Jobs relating to a particular activity.
void	removeRole(String roleName) Removes the given Role from this Agent.

Methods inherited from class org.cristalise.kernel.entity.ItemImplementation

delegatedAction, finalize, getSystemKey, getUUID, initialise, queryData, queryLifeCycle, requestAction

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cristalise.kernel.entity.ItemOperations

delegatedAction, getSystemKey, initialise, queryData, queryLifeCycle, requestAction

Constructor Detail

AgentImplementation

public AgentImplementation(AgentPath path)

Method Detail

refreshJobList

public void refreshJobList(SystemKey sysKey,
                  String stepPath,
                  String newJobs)

Updates an Agent's list of Jobs relating to a particular activity. Only Activities that are assigned to a Role that is flagged to push Jobs do this.

Specified by:

refreshJobList in interface AgentOperations

Parameters:

sysKey - the item which generated the jobs. The Agent should discard any existing jobs for that Item.

stepPath - the Activity within the lifecycle of the item which the jobs relate to

newJobs - an XML marshalled JobArrayList containing the new Jobs

addRole

public void addRole(String roleName)
             throws CannotManageException,
                    ObjectNotFoundException

Adds the given Role to this Agent. Called from the SetAgentRoles predefined step.

Specified by:

addRole in interface AgentOperations

Parameters:

roleName - - the new Role to add

Throws:

CannotManageException - When the process has no lookup manager

ObjectNotFoundException

ObjectNotFoundException - when the role doesn't exist

removeRole

public void removeRole(String roleName)
                throws CannotManageException,
                       ObjectNotFoundException

Removes the given Role from this Agent. Called by the SetAgentRoles predefined step.

Specified by:

removeRole in interface AgentOperations

Parameters:

roleName -

Throws:

CannotManageException - when an error occurs writing the data to LDAP

ObjectNotFoundException

getNewPredefStepContainer

protected PredefinedStepContainer getNewPredefStepContainer()

Agents have their own predefined step containers. They contain the standard predefined steps, plus special Agent ones related to Agent management and instantiation.

Overrides:

getNewPredefStepContainer in class ItemImplementation

See Also:

AgentPredefinedStepContainer