com.dtolabs.rundeck.core.rules

Class WorkflowEngine

java.lang.Object

com.dtolabs.rundeck.core.rules.WorkflowEngine

All Implemented Interfaces:

WorkflowSystem

public class WorkflowEngine
extends java.lang.Object
implements WorkflowSystem

A WorkflowSystem which processes the operations by use of a rule system and a mutable state. implementation: Operations can supply state changes after they succeed, or fail. State changes provided by operations are added in the order they are received, and after a set of available state changes are added, the rule engine is used to update the state based on its rules. After the state is updated, all pending operations are queried to see if they can run given the new state, and any that can are queued to be executed. Workflow processing stops when no operations are currently running, no new state changes are available, and no pending operations can be run.

Nested Class Summary

Nested classes/interfaces inherited from interface com.dtolabs.rundeck.core.rules.WorkflowSystem

WorkflowSystem.Operation<X,T extends WorkflowSystem.OperationCompleted>, WorkflowSystem.OperationCompleted<T>, WorkflowSystem.OperationResult<D,T extends WorkflowSystem.OperationCompleted<D>,X extends WorkflowSystem.Operation<D,T>>, WorkflowSystem.SharedData<T>

Constructor Summary

Constructors

Constructor and Description
WorkflowEngine(RuleEngine engine, MutableStateObj state, java.util.concurrent.ExecutorService executor) Create engine

Method Summary

Modifier and Type	Method and Description
WorkflowSystemEventListener	getListener()
boolean	isInterrupted()
protected boolean	isWorkflowEndState(MutableStateObj state)
<DAT,RES extends WorkflowSystem.OperationCompleted<DAT>,OP extends WorkflowSystem.Operation<DAT,RES>> java.util.Set<WorkflowSystem.OperationResult<DAT,RES,OP>>	processOperations(java.util.Set<OP> operations, WorkflowSystem.SharedData<DAT> sharedData) Process the operations and return results when all runnable operations are complete.
void	setInterrupted(boolean interrupted)
void	setListener(WorkflowSystemEventListener listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowEngine

public WorkflowEngine(RuleEngine engine,
                      MutableStateObj state,
                      java.util.concurrent.ExecutorService executor)

Create engine

Parameters:

engine - rule engine to process state changes via rules

state - initial state

executor - executor to process operations, which should be multithreaded to process operations concurrently

Method Detail

processOperations

public <DAT,RES extends WorkflowSystem.OperationCompleted<DAT>,OP extends WorkflowSystem.Operation<DAT,RES>> java.util.Set<WorkflowSystem.OperationResult<DAT,RES,OP>> processOperations(java.util.Set<OP> operations,
                                                                                                                                                                                         WorkflowSystem.SharedData<DAT> sharedData)

Description copied from interface: WorkflowSystem

Process the operations and return results when all runnable operations are complete.

Specified by:

processOperations in interface WorkflowSystem

Type Parameters:

DAT - shared data type

RES - success result of an operation

OP - operation class

Parameters:

operations - operations

Returns:

set of results for all processed operations

isWorkflowEndState

protected boolean isWorkflowEndState(MutableStateObj state)

getListener

public WorkflowSystemEventListener getListener()

setListener

public void setListener(WorkflowSystemEventListener listener)

isInterrupted

public boolean isInterrupted()

Specified by:

isInterrupted in interface WorkflowSystem

Returns:

true if the previous call to WorkflowSystem.processOperations(Set, SharedData) stopped due to interruption

setInterrupted

public void setInterrupted(boolean interrupted)