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

UserCodeProcess provides a very basic automatic execution of Scripts associated with the Jobs (Activities). It is based on the Default StateMachine, and it implements the following sequence:

 1. assessStartConditions()
 2. start()
 3. complete()
 4. in case of error/exception execute error transition which is suspend for default statemachine

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	active
static String	DEFAULT_PASSWORD Defines the default password (value:"uc").
static String	DEFAULT_ROLE Defines the default role (value:"UserCode").
protected HashMap<String,C2KLocalObject>	jobs
static String	STATE_MACHINE_COMPLETE_TRANSITION Defines the name of the CRISTAL Property (value:"StateMachine.completeTransition") to override the default mapping for Complete transition.
static String	STATE_MACHINE_ERROR_TRANSITION Defines the name of the CRISTAL Property (value:"StateMachine.errorTransition") to override the default mapping for Error transition.
static String	STATE_MACHINE_START_TRANSITION Defines the name of the CRISTAL Property (value:"StateMachine.startTransition") to override the default mapping for Start transition.
static String	USERCODE_IGNORE Defines the value (value:"USERCODE_IGNORE") to to be used in CRISTAL Property to ignore the Jobs of that Transition eg: UserCode.StateMachine.resumeTransition = USERCODE_IGNORE

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, MAIN_ARG_RESETIOR, MAIN_ARG_SKIPBOOTSTRAP

Constructor Summary

Constructors

Constructor and Description
UserCodeProcess() Default constructor set up the user code with default setting
UserCodeProcess(String propPrefix) Constructor set up the user code

Method Summary

Modifier and Type	Method and Description
void	add(Job job) 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
static String	getAgentName()
static String	getAgentPassword()
String	getDesc()
static ImportRole	getImportRole()
static String	getRoleName()
static List<String>	getRolePermissions()
static void	main(String[] args)
void	remove(String id) Job removal notification from the AgentProxy.
void	run()
void	runUserCodeLogic(Job job, Job errorJob) 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.

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

getRequiredStateMachine, login

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

readC2KArgs, readPropertyFiles, setShutdownHandler, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ROLE

public static final String DEFAULT_ROLE

Defines the default role (value:"UserCode"). It also used as a prefix for every configuration property eg: UserCode.StateMachine.startTransition

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final String DEFAULT_PASSWORD

Defines the default password (value:"uc").

See Also:

Constant Field Values

STATE_MACHINE_START_TRANSITION

public static final String STATE_MACHINE_START_TRANSITION

Defines the name of the CRISTAL Property (value:"StateMachine.startTransition") to override the default mapping for Start transition. It is always prefixed like this: eg: UserCode.StateMachine.startTransition

See Also:

Constant Field Values

STATE_MACHINE_COMPLETE_TRANSITION

public static final String STATE_MACHINE_COMPLETE_TRANSITION

Defines the name of the CRISTAL Property (value:"StateMachine.completeTransition") to override the default mapping for Complete transition. It is always prefixed like this: eg: UserCode.StateMachine.completeTransition

See Also:

Constant Field Values

STATE_MACHINE_ERROR_TRANSITION

public static final String STATE_MACHINE_ERROR_TRANSITION

Defines the name of the CRISTAL Property (value:"StateMachine.errorTransition") to override the default mapping for Error transition. It is always prefixed like this: eg: UserCode.StateMachine.errorTransition

See Also:

Constant Field Values

USERCODE_IGNORE

public static final String USERCODE_IGNORE

Defines the value (value:"USERCODE_IGNORE") to to be used in CRISTAL Property to ignore the Jobs of that Transition eg: UserCode.StateMachine.resumeTransition = USERCODE_IGNORE

See Also:

Constant Field Values

active

protected static boolean active

jobs

protected final HashMap<String,C2KLocalObject> jobs

Constructor Detail

UserCodeProcess

public UserCodeProcess()
                throws InvalidDataException,
                       ObjectNotFoundException

Default constructor set up the user code with default setting

Throws:

InvalidDataException - incorrect configration

ObjectNotFoundException - StateMachine to configure the UserCode was not found

UserCodeProcess

public UserCodeProcess(String propPrefix)
                throws InvalidDataException,
                       ObjectNotFoundException

Constructor set up the user code

Parameters:

propPrefix - string to be used as prefix for each property

Throws:

InvalidDataException - StateMachine does not have the named Transition

ObjectNotFoundException - StateMachine was not found

Method Detail

getRoleName

public static String getRoleName()

Returns:

getRolePermissions

public static List<String> getRolePermissions()

Returns:

getImportRole

public static ImportRole getImportRole()

Returns:

getAgentName

public static String getAgentName()

Returns:

getAgentPassword

public static String getAgentPassword()

Returns:

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. Override this method to implement application specific action for Jobs of 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. Override this method to implement application specific action for Jobs of Complete Transition.

Parameters:

thisJob - the actual Job to be executed.

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

Throws:

Exception

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,
                             Job errorJob)
                      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.

errorJob - Job to be executed in case of an error

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

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)