Package step.core.execution

Class ExecutionEngine

java.lang.Object

step.core.execution.ExecutionEngine

public class ExecutionEngine
extends Object

This class represent the central component for the execution of Plans. It supports local executions as well as central executions within controller instances. It replaces all the classes implementing the legacy PlanRunner interface

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExecutionEngine.Builder

Method Summary

Modifier and Type	Method	Description
static ExecutionEngine.Builder	builder()
PlanRunnerResult	execute(String executionId)	Executes an Execution previously initialized by ExecutionEngine#initializeExecution(ExecutionParameters, String)
PlanRunnerResult	execute(ExecutionParameters executionParameterObject)	Create a new execution and runs the plan specified within the provided ExecutionParameters
PlanRunnerResult	execute(Plan plan)	Create a new execution and runs the provided plan as part of this Execution
PlanRunnerResult	execute(Plan plan, Map<String,String> executionParameters)	Create a new execution and runs the provided plan as part of this Execution
List<ExecutionContext>	getCurrentExecutions()
ExecutionEngineContext	getExecutionEngineContext()
String	initializeExecution(ExecutionParameters executionParameters)	Initializes an execution based on the provided parameters.
String	initializeExecution(ExecutiontTaskParameters executionTaskParameters)	Initializes an execution based on the provided parameters.
ExecutionContext	newExecutionContext()
protected ExecutionContext	newExecutionContext(String executionId, ExecutionParameters executionParameters, ExecutiontTaskParameters executiontTaskParameters)

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ExecutionEngine.Builder builder()

Returns:

a new instance of the ExecutionEngine build

getExecutionEngineContext

public ExecutionEngineContext getExecutionEngineContext()

Returns:

the ExecutionEngineContext of this ExecutionEngine

initializeExecution

public String initializeExecution(ExecutionParameters executionParameters)

Initializes an execution based on the provided parameters. This creates and persists a new Execution instance. This method call should be followed by execute(String)

Parameters:

executionParameters - the ExecutionParameters of the Execution to be created

Returns:

the ID of the new Execution

initializeExecution

public String initializeExecution(ExecutiontTaskParameters executionTaskParameters)

Initializes an execution based on the provided parameters. This creates and persists a new Execution instance. This method call should be followed by execute(String)

Parameters:

executionTaskParameters - the ExecutiontTaskParameters of the Execution to be created

Returns:

the ID of the new Execution

execute

public PlanRunnerResult execute(String executionId)

Executes an Execution previously initialized by ExecutionEngine#initializeExecution(ExecutionParameters, String)

Parameters:

executionId - the ID of the Execution initialized and returned by ExecutionEngine#initializeExecution(ExecutionParameters, String)

Returns:

the result of the execution

execute

public PlanRunnerResult execute(Plan plan)

Create a new execution and runs the provided plan as part of this Execution

Parameters:

plan - the Plan to be executed

Returns:

execute

public PlanRunnerResult execute(Plan plan,
                                Map<String,String> executionParameters)

Create a new execution and runs the provided plan as part of this Execution

Parameters:

plan - the Plan to be executed

executionParameters - the map of execution parameters. These parameters are equivalent to the parameters selected on the execution screen of the STEP UI

Returns:

execute

public PlanRunnerResult execute(ExecutionParameters executionParameterObject)

Create a new execution and runs the plan specified within the provided ExecutionParameters

Parameters:

executionParameterObject - the

Returns:

newExecutionContext

public ExecutionContext newExecutionContext()

Returns:

a new ExecutionContext. Warning: This method should only be used for testing purposes i.e. for tests requiring an ExecutionContext without ExecutionEngine

newExecutionContext

protected ExecutionContext newExecutionContext(String executionId,
                                               ExecutionParameters executionParameters,
                                               ExecutiontTaskParameters executiontTaskParameters)

getCurrentExecutions

public List<ExecutionContext> getCurrentExecutions()

Returns:

the List of currently running executions