eu.vicci.process.model.sofiainstance.util

Enum LifeCycleManager

java.lang.Object

java.lang.Enum<LifeCycleManager>

eu.vicci.process.model.sofiainstance.util.LifeCycleManager

All Implemented Interfaces:

Serializable, Comparable<LifeCycleManager>

public enum LifeCycleManager
extends Enum<LifeCycleManager>

This LifeCycleManager should be used to interact with port-, transition- and processstepinstances (e.g. activate port, execute processstep,...). It uses an Akka ActorSystem to execute the processsteps decoupled. Synchronus / blocking calls are indicated (*Sync())

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton-instance of the LifeCycleManager

Method Summary

Modifier and Type	Method and Description
void	activatePort(eu.vicci.process.model.sofiainstance.PortInstance port) Activates a port
void	activatePort(eu.vicci.process.model.sofiainstance.PortInstance port, eu.vicci.process.model.sofiainstance.DataTypeInstance parameter) Activates a port
boolean	activatePortSync(eu.vicci.process.model.sofiainstance.PortInstance port) Activates a port.
boolean	activatePortSync(eu.vicci.process.model.sofiainstance.PortInstance port, eu.vicci.process.model.sofiainstance.DataTypeInstance parameter) Activates a port.
void	changePortExecutionState(eu.vicci.process.model.sofiainstance.PortInstance port, eu.vicci.process.model.sofiainstance.State newExecutionstate) Changes the execution state of a port.
akka.actor.ActorRef	createActorForEndPortSync(eu.vicci.process.model.sofiainstance.PortInstance endPort, akka.actor.ActorRef parent) Creates an actor in the context from a parent actor.
akka.actor.ActorRef	createActorForProcessSync(ProcessStepInstanceImplCustom processStepInstance, akka.actor.ActorRef parent) Creates an actor in the context from a parent actor.
akka.actor.ActorRef	createActorForStartControlPortSync(eu.vicci.process.model.sofiainstance.StartControlPortInstance portInstance, akka.actor.ActorRef parent) Creates an actor in the context from a parent actor.
akka.actor.ActorRef	createActorForStartDataPortSync(eu.vicci.process.model.sofiainstance.StartDataPortInstance portInstance, akka.actor.ActorRef parent) Creates an actor in the context from a parent actor.
akka.actor.ActorRef	createActorForTransitionSync(eu.vicci.process.model.sofiainstance.TransitionInstance instance, akka.actor.ActorRef parent) Creates an actor in the context from a parent actor.
void	deactivatePort(eu.vicci.process.model.sofiainstance.PortInstance port) Deactivate a port.
void	deactivateProcessStep(eu.vicci.process.model.sofiainstance.ProcessStepInstance processStep) Deactivate a process step.
void	deactivateTransition(eu.vicci.process.model.sofiainstance.TransitionInstance instance) Deactivate a transition.
void	escalateProcessStep(eu.vicci.process.model.sofiainstance.ProcessStepInstance processStep)
boolean	executeProcessStep(eu.vicci.process.model.sofiainstance.ProcessStepInstance processStep) Executes a process step
void	executeTransition(eu.vicci.process.model.sofiainstance.TransitionInstance transition) Executes a transition
void	executeTransition(eu.vicci.process.model.sofiainstance.TransitionInstance transition, eu.vicci.process.model.sofiainstance.DataTypeInstance parameter) Executes a transition
boolean	executeTransitionSync(eu.vicci.process.model.sofiainstance.TransitionInstance transition) Executes a transition.
boolean	executeTransitionSync(eu.vicci.process.model.sofiainstance.TransitionInstance transition, eu.vicci.process.model.sofiainstance.DataTypeInstance parameter) Executes a transition.
void	killProcessStep(ActorAssignable processStep) Kills the given process
void	pauseProcessStep(ActorAssignable processStep) Pauses the given process
void	portExecutionStateChanged(PortExecutionStateChangedListener listener, eu.vicci.process.model.sofiainstance.PortInstance port) Informs a listener, when the execution state of a port has changed.
void	processExecuted(ProcessExecutedListener listener, ProcessStepInstanceImplCustom executedProcess) Informs a listener, that a process has finished executing
void	processReset(ProcessResetListener listener, ProcessStepInstanceImplCustom resetProcess) Informs the listener, when a process has been succesfully reset.
void	reset() Stops the Actor Systems and assigns a new process execution master an sets up a new ActorSystem.
void	resetProcess(eu.vicci.process.model.sofiainstance.ProcessStepInstance process) Reset a processstep.
void	resumeProcessStep(ActorAssignable processStep) Resumes the given process
boolean	setPortDataTypeInstanceSync(eu.vicci.process.model.sofiainstance.DataPortInstance port, eu.vicci.process.model.sofiainstance.DataTypeInstance dataTypeInstance) Sets the DataTypeInstance of a DataPortInstance.
void	stopActorSystem() This stops the Actorsystem.
void	stopProcessStep(ActorAssignable processStep) Stops the given process
static LifeCycleManager	valueOf(String name) Returns the enum constant of this type with the specified name.
static LifeCycleManager[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final LifeCycleManager INSTANCE

The singleton-instance of the LifeCycleManager

Method Detail

values

public static LifeCycleManager[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LifeCycleManager c : LifeCycleManager.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LifeCycleManager valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

activatePort

public void activatePort(eu.vicci.process.model.sofiainstance.PortInstance port,
                         eu.vicci.process.model.sofiainstance.DataTypeInstance parameter)

Activates a port

Parameters:

port -

parameter -

activatePort

public void activatePort(eu.vicci.process.model.sofiainstance.PortInstance port)

Activates a port

Parameters:

port -

activatePortSync

public boolean activatePortSync(eu.vicci.process.model.sofiainstance.PortInstance port)

Activates a port. Blocking Call.

Parameters:

port -

Returns:

activatePortSync

public boolean activatePortSync(eu.vicci.process.model.sofiainstance.PortInstance port,
                                eu.vicci.process.model.sofiainstance.DataTypeInstance parameter)

Activates a port. Blocking Call.

Parameters:

port -

parameter -

Returns:

executeTransition

public void executeTransition(eu.vicci.process.model.sofiainstance.TransitionInstance transition,
                              eu.vicci.process.model.sofiainstance.DataTypeInstance parameter)

Executes a transition

Parameters:

transition -

parameter -

executeTransition

public void executeTransition(eu.vicci.process.model.sofiainstance.TransitionInstance transition)

Executes a transition

Parameters:

transition -

executeTransitionSync

public boolean executeTransitionSync(eu.vicci.process.model.sofiainstance.TransitionInstance transition,
                                     eu.vicci.process.model.sofiainstance.DataTypeInstance parameter)

Executes a transition. Blocking call.

Parameters:

transition -

parameter -

Returns:

executeTransitionSync

public boolean executeTransitionSync(eu.vicci.process.model.sofiainstance.TransitionInstance transition)

Executes a transition. Blocking call.

Parameters:

transition -

Returns:

executeProcessStep

public boolean executeProcessStep(eu.vicci.process.model.sofiainstance.ProcessStepInstance processStep)

Executes a process step

Parameters:

processStep -

stopProcessStep

public void stopProcessStep(ActorAssignable processStep)

Stops the given process

Parameters:

processStep -

resumeProcessStep

public void resumeProcessStep(ActorAssignable processStep)

Resumes the given process

Parameters:

processStep -

killProcessStep

public void killProcessStep(ActorAssignable processStep)

Kills the given process

Parameters:

processStep -

pauseProcessStep

public void pauseProcessStep(ActorAssignable processStep)

Pauses the given process

Parameters:

processStep -

createActorForEndPortSync

public akka.actor.ActorRef createActorForEndPortSync(eu.vicci.process.model.sofiainstance.PortInstance endPort,
                                                     akka.actor.ActorRef parent)

Creates an actor in the context from a parent actor. The created actor will become the parents child-actor

Parameters:

endPort -

parent -

Returns:

createActorForProcessSync

public akka.actor.ActorRef createActorForProcessSync(ProcessStepInstanceImplCustom processStepInstance,
                                                     akka.actor.ActorRef parent)

Creates an actor in the context from a parent actor. The created actor will become the parents child-actor

Parameters:

processStepInstance -

parent -

Returns:

createActorForStartControlPortSync

public akka.actor.ActorRef createActorForStartControlPortSync(eu.vicci.process.model.sofiainstance.StartControlPortInstance portInstance,
                                                              akka.actor.ActorRef parent)

Creates an actor in the context from a parent actor. The created actor will become the parents child-actor

Parameters:

portInstance -

parent -

Returns:

createActorForStartDataPortSync

public akka.actor.ActorRef createActorForStartDataPortSync(eu.vicci.process.model.sofiainstance.StartDataPortInstance portInstance,
                                                           akka.actor.ActorRef parent)

Creates an actor in the context from a parent actor. The created actor will become the parents child-actor

Parameters:

portInstance -

parent -

Returns:

createActorForTransitionSync

public akka.actor.ActorRef createActorForTransitionSync(eu.vicci.process.model.sofiainstance.TransitionInstance instance,
                                                        akka.actor.ActorRef parent)

Creates an actor in the context from a parent actor. The created actor will become the parents child-actor

Parameters:

instance -

parent -

Returns:

processExecuted

public void processExecuted(ProcessExecutedListener listener,
                            ProcessStepInstanceImplCustom executedProcess)

Informs a listener, that a process has finished executing

Parameters:

listener -

executedProcess -

processReset

public void processReset(ProcessResetListener listener,
                         ProcessStepInstanceImplCustom resetProcess)

Informs the listener, when a process has been succesfully reset.

Parameters:

listener -

resetProcess -

stopActorSystem

public void stopActorSystem()

This stops the Actorsystem. After the execution of the process, the Actorsystem should be stopped by the user. This method blocks, till the actorsystem is down.

deactivateTransition

public void deactivateTransition(eu.vicci.process.model.sofiainstance.TransitionInstance instance)

Deactivate a transition.

Parameters:

instance -

deactivateProcessStep

public void deactivateProcessStep(eu.vicci.process.model.sofiainstance.ProcessStepInstance processStep)

Deactivate a process step.

Parameters:

processStep -

escalateProcessStep

public void escalateProcessStep(eu.vicci.process.model.sofiainstance.ProcessStepInstance processStep)

deactivatePort

public void deactivatePort(eu.vicci.process.model.sofiainstance.PortInstance port)

Deactivate a port.

Parameters:

port -

resetProcess

public void resetProcess(eu.vicci.process.model.sofiainstance.ProcessStepInstance process)

Reset a processstep.

Parameters:

process -

changePortExecutionState

public void changePortExecutionState(eu.vicci.process.model.sofiainstance.PortInstance port,
                                     eu.vicci.process.model.sofiainstance.State newExecutionstate)

Changes the execution state of a port.

Parameters:

port -

newExecutionstate -

portExecutionStateChanged

public void portExecutionStateChanged(PortExecutionStateChangedListener listener,
                                      eu.vicci.process.model.sofiainstance.PortInstance port)

Informs a listener, when the execution state of a port has changed.

Parameters:

listener -

port -

setPortDataTypeInstanceSync

public boolean setPortDataTypeInstanceSync(eu.vicci.process.model.sofiainstance.DataPortInstance port,
                                           eu.vicci.process.model.sofiainstance.DataTypeInstance dataTypeInstance)

Sets the DataTypeInstance of a DataPortInstance. Blocking Call.

Parameters:

port -

dataTypeInstance -

Returns:

reset

public void reset()

Stops the Actor Systems and assigns a new process execution master an sets up a new ActorSystem. This can be helpful for unit tests.