org.cristalise.kernel.process

Class UserCodeProcess

java.lang.Object

org.cristalise.kernel.process.AbstractMain

org.cristalise.kernel.process.StandardClient

org.cristalise.kernel.process.UserCodeProcess

All Implemented Interfaces:

Runnable, ProxyObserver<Job>

public class UserCodeProcess
extends StandardClient
implements ProxyObserver<Job>, Runnable

Field Summary

Fields inherited from class org.cristalise.kernel.process.StandardClient

agent

Fields inherited from class org.cristalise.kernel.process.AbstractMain

isServer, MAIN_ARG_CONFIG, MAIN_ARG_CONNECT, MAIN_ARG_LOGFILE, MAIN_ARG_LOGLEVEL, MAIN_ARG_NONEWLOGSTREAM

Constructor Summary

Constructors

Constructor and Description
UserCodeProcess()

Method Summary

Modifier and Type	Method and Description
void	add(Job contents) Receives job from the AgentProxy.
boolean	assessStartConditions(Job job) Override this method to implement application specific evaluation of start condition.
void	complete(Job thisJob, String jobKey) Method called to handle the Complete transition
void	control(String control, String msg)
protected Job	getActualJob() Gets the next possible Job based on the Transitions of the Default StateMachine
String	getDesc()
static void	main(String[] args)
void	remove(String id) Job removal notification from the AgentProxy.
void	resume(Job thisJob, String jobKey) Method called to handle the Resume transition
void	run()
void	runUserCodeLogic(Job job) Override this mehod to implement application specific (business) logic Default implementation - the agent execute any scripts, query or both defined
static void	shutdown()
void	start(Job thisJob, String jobKey) Method called to handle the Start transition
void	suspend(Job thisJob, String jobKey) Method called to handle the Suspend transition

Methods inherited from class org.cristalise.kernel.process.StandardClient

getRequiredStateMachine, login

Methods inherited from class org.cristalise.kernel.process.AbstractMain

readC2KArgs, setShutdownHandler, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

UserCodeProcess

public UserCodeProcess()
                throws InvalidDataException,
                       ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

Method Detail

run

public void run()

Specified by:

run in interface Runnable

start

public void start(Job thisJob,
                  String jobKey)
           throws AccessRightsException,
                  InvalidDataException,
                  InvalidTransitionException,
                  ObjectNotFoundException,
                  PersistencyException,
                  ObjectAlreadyExistsException,
                  ScriptErrorException,
                  InvalidCollectionModification

Method called to handle the Start transition

Parameters:

thisJob - the actual Job to be executed.

jobKey - the key of the job (i.e. itemPath:stepPat)

Throws:

AccessRightsException

InvalidDataException

InvalidTransitionException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

ScriptErrorException

InvalidCollectionModification

complete

public void complete(Job thisJob,
                     String jobKey)
              throws Exception

Method called to handle the Complete transition

Parameters:

thisJob - the actual Job to be executed.

jobKey - the key of the job (i.e. itemPath:stepPat)

Throws:

Exception

resume

public void resume(Job thisJob,
                   String jobKey)
            throws AccessRightsException,
                   InvalidDataException,
                   InvalidTransitionException,
                   ObjectNotFoundException,
                   PersistencyException,
                   ObjectAlreadyExistsException,
                   ScriptErrorException,
                   InvalidCollectionModification

Method called to handle the Resume transition

Parameters:

thisJob - the actual Job to be executed.

jobKey - the key of the job (i.e. itemPath:stepPat)

Throws:

AccessRightsException

InvalidDataException

InvalidTransitionException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

ScriptErrorException

InvalidCollectionModification

suspend

public void suspend(Job thisJob,
                    String jobKey)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException,
                    InvalidDataException,
                    ObjectNotFoundException,
                    IOException,
                    org.exolab.castor.mapping.MappingException,
                    AccessRightsException,
                    InvalidTransitionException,
                    PersistencyException,
                    ObjectAlreadyExistsException,
                    InvalidCollectionModification,
                    ScriptErrorException

Method called to handle the Suspend transition

Parameters:

thisJob - the actual Job to be executed.

jobKey - the key of the job (i.e. itemPath:stepPat)

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

InvalidDataException

ObjectNotFoundException

IOException

org.exolab.castor.mapping.MappingException

AccessRightsException

InvalidTransitionException

PersistencyException

ObjectAlreadyExistsException

InvalidCollectionModification

ScriptErrorException

assessStartConditions

public boolean assessStartConditions(Job job)

Override this method to implement application specific evaluation of start condition. Default implementation - returns always true, i.e. there were no start conditions.

Parameters:

job - the actual Job to be executed.

Returns:

true, if the start condition were met

runUserCodeLogic

public void runUserCodeLogic(Job job)
                      throws AccessRightsException,
                             InvalidDataException,
                             InvalidTransitionException,
                             ObjectNotFoundException,
                             PersistencyException,
                             ObjectAlreadyExistsException,
                             InvalidCollectionModification,
                             ScriptErrorException

Override this mehod to implement application specific (business) logic Default implementation - the agent execute any scripts, query or both defined

Parameters:

job - the actual Job to be executed.

Throws:

AccessRightsException

InvalidDataException

InvalidTransitionException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

InvalidCollectionModification

ScriptErrorException

getActualJob

protected Job getActualJob()

Gets the next possible Job based on the Transitions of the Default StateMachine

Returns:

the actual Job

add

public void add(Job contents)

Receives job from the AgentProxy. Reactivates thread if sleeping.

Specified by:

add in interface ProxyObserver<Job>

control

public void control(String control,
                    String msg)

Specified by:

control in interface ProxyObserver<Job>

remove

public void remove(String id)

Job removal notification from the AgentProxy.

Specified by:

remove in interface ProxyObserver<Job>

getDesc

public String getDesc()

shutdown

public static void shutdown()

main

public static void main(String[] args)