Package com.dtolabs.rundeck.core.execution.workflow

Class BaseWorkflowExecutor

java.lang.Object

com.dtolabs.rundeck.core.execution.workflow.BaseWorkflowExecutor

All Implemented Interfaces:

WorkflowExecutor

Direct Known Subclasses:

EngineWorkflowExecutor, NodeFirstWorkflowExecutor

public abstract class BaseWorkflowExecutor
extends java.lang.Object
implements WorkflowExecutor

BaseWorkflowStrategy is ...

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BaseWorkflowExecutor.BaseWorkflowExecutionResult
static class	BaseWorkflowExecutor.StepResultCapture

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	OPTION_KEY
protected static java.lang.String	SECURE_OPTION_KEY
protected static java.lang.String	SECURE_OPTION_VALUE
protected static WorkflowStatusResult	WorkflowResultFailed	Failure result

Fields inherited from interface com.dtolabs.rundeck.core.execution.workflow.WorkflowExecutor

NODE_FIRST, PARALLEL, STEP_FIRST

Constructor Summary

Constructors

Constructor	Description
BaseWorkflowExecutor(IFramework framework)

Method Summary

Modifier and Type	Method	Description
protected void	addNodeStepFailureContextData(StepExecutionResult dispatcherStepResult, ExecutionContextImpl.Builder builder)	Add any node-specific step failure information to the node-specific data contexts
protected void	addStepFailureContextData(StepExecutionResult stepResult, ExecutionContextImpl.Builder builder)	Add step result failure information to the data context
void	combineNodeResultData(int c, StepExecutionResult stepResult, WFSharedContext combinedResultData)
void	combineResultData(int c, DataOutput outputContext, WFSharedContext combinedResultData, StepExecutionResult handlerResult)
protected java.util.Map<java.lang.String,java.util.Collection<StepExecutionResult>>	convertFailures(java.util.Map<java.lang.Integer,StepExecutionResult> failedMap)	Convert map of step execution results keyed by step number, to a collection of step execution results keyed by node name
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	createPrintableDataContext(java.lang.String optionKey, java.lang.String secureOptionKey, java.lang.String secureOptionValue, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> dataContext)	Creates a copy of the given data context with the secure option values obfuscated.
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	createPrintableDataContext(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> dataContext)	Creates a copy of the given data context with the secure option values obfuscated.
protected StepExecutionResult	executeWFItem(StepExecutionContext executionContext, java.util.Map<java.lang.Integer,StepExecutionResult> failedMap, int c, StepExecutionItem cmd)	Execute a workflow item, returns true if the item succeeds.
WorkflowExecutionResult	executeWorkflow(StepExecutionContext executionContext, WorkflowExecutionItem item)
abstract WorkflowExecutionResult	executeWorkflowImpl(StepExecutionContext executionContext, WorkflowExecutionItem item)
protected WorkflowStatusResult	executeWorkflowItemsForNodeSet(StepExecutionContext executionContext, java.util.Map<java.lang.Integer,StepExecutionResult> failedMap, java.util.List<StepExecutionResult> resultList, java.util.List<StepExecutionItem> iWorkflowCmdItems, boolean keepgoing, int beginStepIndex, WFSharedContext sharedContext)	Deprecated. should invoke engine workflow executor
BaseWorkflowExecutor.StepResultCapture	executeWorkflowStep(StepExecutionContext executionContext, java.util.Map<java.lang.Integer,StepExecutionResult> failedMap, java.util.List<StepExecutionResult> resultList, boolean keepgoing, WorkflowExecutionListener wlistener, int c, StepExecutionItem cmd)	Execute a step and handle flow control and error handler and log filter.
protected IFramework	getFramework()
protected WorkflowExecutionListener	getWorkflowListener(ExecutionContext executionContext)
protected static NodeStepResult	nodeStepResultFromNodeStepException(INodeEntry node, NodeStepException nodeStepException)
protected ExecutionContextImpl.Builder	replaceFailedNodesListenerInContext(ExecutionContextImpl.Builder builder, FailedNodesListener captureFailedNodesListener, ExecutionListener executionListener)
void	reportNodesMatched(StepExecutionContext executionContext, NodeRecorder stepCaptureFailedNodesListener)
protected void	validateNodeSet(ExecutionContext executionContext, NodesSelector nodeSelector)
protected static WorkflowStatusDataResult	workflowResult(boolean status, java.lang.String statusString, ControlBehavior behavior, WFSharedContext sharedContext)

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_KEY

protected static final java.lang.String OPTION_KEY

See Also:

Constant Field Values

SECURE_OPTION_KEY

protected static final java.lang.String SECURE_OPTION_KEY

See Also:

Constant Field Values

SECURE_OPTION_VALUE

protected static final java.lang.String SECURE_OPTION_VALUE

See Also:

Constant Field Values

WorkflowResultFailed

protected static final WorkflowStatusResult WorkflowResultFailed

Failure result

Constructor Detail

BaseWorkflowExecutor

public BaseWorkflowExecutor(IFramework framework)

Method Detail

workflowResult

protected static WorkflowStatusDataResult workflowResult(boolean status,
                                                         java.lang.String statusString,
                                                         ControlBehavior behavior,
                                                         WFSharedContext sharedContext)

Parameters:

status - success/failure

statusString - status string

behavior - control behavior

Returns:

result with the given input

getFramework

protected IFramework getFramework()

executeWorkflow

public final WorkflowExecutionResult executeWorkflow(StepExecutionContext executionContext,
                                                     WorkflowExecutionItem item)

Specified by:

executeWorkflow in interface WorkflowExecutor

getWorkflowListener

protected WorkflowExecutionListener getWorkflowListener(ExecutionContext executionContext)

executeWorkflowImpl

public abstract WorkflowExecutionResult executeWorkflowImpl(StepExecutionContext executionContext,
                                                            WorkflowExecutionItem item)

executeWFItem

protected StepExecutionResult executeWFItem(StepExecutionContext executionContext,
                                            java.util.Map<java.lang.Integer,StepExecutionResult> failedMap,
                                            int c,
                                            StepExecutionItem cmd)

Execute a workflow item, returns true if the item succeeds. This method will throw an exception if the workflow item fails and the Workflow is has keepgoing==false.

Parameters:

executionContext - context

failedMap - List to add any messages if the item fails

c - index of the WF item

cmd - WF item descriptor

Returns:

true if the execution succeeds, false otherwise

executeWorkflowItemsForNodeSet

protected WorkflowStatusResult executeWorkflowItemsForNodeSet(StepExecutionContext executionContext,
                                                              java.util.Map<java.lang.Integer,StepExecutionResult> failedMap,
                                                              java.util.List<StepExecutionResult> resultList,
                                                              java.util.List<StepExecutionItem> iWorkflowCmdItems,
                                                              boolean keepgoing,
                                                              int beginStepIndex,
                                                              WFSharedContext sharedContext)

Deprecated.

should invoke engine workflow executor

Execute the sequence of ExecutionItems within the context, and with the given keepgoing value

Parameters:

executionContext - context

failedMap - failures

resultList - results

iWorkflowCmdItems - list of steps

keepgoing - true to keepgoing on step failure

beginStepIndex - beginning step index

Returns:

true if successful

addStepFailureContextData

protected void addStepFailureContextData(StepExecutionResult stepResult,
                                         ExecutionContextImpl.Builder builder)

Add step result failure information to the data context

Parameters:

stepResult - result

addNodeStepFailureContextData

protected void addNodeStepFailureContextData(StepExecutionResult dispatcherStepResult,
                                             ExecutionContextImpl.Builder builder)

Add any node-specific step failure information to the node-specific data contexts

Parameters:

dispatcherStepResult - result

builder -

replaceFailedNodesListenerInContext

protected ExecutionContextImpl.Builder replaceFailedNodesListenerInContext(ExecutionContextImpl.Builder builder,
                                                                           FailedNodesListener captureFailedNodesListener,
                                                                           ExecutionListener executionListener)

convertFailures

protected java.util.Map<java.lang.String,java.util.Collection<StepExecutionResult>> convertFailures(java.util.Map<java.lang.Integer,StepExecutionResult> failedMap)

Convert map of step execution results keyed by step number, to a collection of step execution results keyed by node name

Parameters:

failedMap - failures

Returns:

converted

nodeStepResultFromNodeStepException

protected static NodeStepResult nodeStepResultFromNodeStepException(INodeEntry node,
                                                                    NodeStepException nodeStepException)

Parameters:

node - node

nodeStepException - exception

Returns:

a failure result with components from an exception

createPrintableDataContext

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> createPrintableDataContext(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> dataContext)

Creates a copy of the given data context with the secure option values obfuscated. This does not modify the original data context. "secureOption" map values will always be obfuscated. "option" entries that are also in "secureOption" will have their values obfuscated. All other maps within the data context will be added directly to the copy.

Parameters:

dataContext - data

Returns:

printable data

createPrintableDataContext

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> createPrintableDataContext(java.lang.String optionKey,
                                                                                                                                  java.lang.String secureOptionKey,
                                                                                                                                  java.lang.String secureOptionValue,
                                                                                                                                  java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> dataContext)

Creates a copy of the given data context with the secure option values obfuscated. This does not modify the original data context. "secureOption" map values will always be obfuscated. "option" entries that are also in "secureOption" will have their values obfuscated. All other maps within the data context will be added directly to the copy.

Parameters:

optionKey - key

secureOptionKey - secure key

secureOptionValue - secure value

dataContext - data

Returns:

printable data

executeWorkflowStep

public BaseWorkflowExecutor.StepResultCapture executeWorkflowStep(StepExecutionContext executionContext,
                                                                  java.util.Map<java.lang.Integer,StepExecutionResult> failedMap,
                                                                  java.util.List<StepExecutionResult> resultList,
                                                                  boolean keepgoing,
                                                                  WorkflowExecutionListener wlistener,
                                                                  int c,
                                                                  StepExecutionItem cmd)

Execute a step and handle flow control and error handler and log filter.

Parameters:

executionContext - context

failedMap - map for placing failure results

resultList - list of step results

keepgoing - true if the workflow should keepgoing on error

wlistener - listener

c - step number

cmd - step

Returns:

result and flow control

combineResultData

public void combineResultData(int c,
                              DataOutput outputContext,
                              WFSharedContext combinedResultData,
                              StepExecutionResult handlerResult)

reportNodesMatched

public void reportNodesMatched(StepExecutionContext executionContext,
                               NodeRecorder stepCaptureFailedNodesListener)

validateNodeSet

protected void validateNodeSet(ExecutionContext executionContext,
                               NodesSelector nodeSelector)

combineNodeResultData

public void combineNodeResultData(int c,
                                  StepExecutionResult stepResult,
                                  WFSharedContext combinedResultData)