com.dtolabs.rundeck.core.execution.workflow

Class BaseWorkflowStrategy

java.lang.Object

com.dtolabs.rundeck.core.execution.workflow.BaseWorkflowStrategy

All Implemented Interfaces:

WorkflowExecutor, WorkflowStrategy

Direct Known Subclasses:

NodeFirstWorkflowStrategy, ParallelWorkflowStrategy, StepFirstWorkflowStrategy

public abstract class BaseWorkflowStrategy
extends java.lang.Object
implements WorkflowStrategy

BaseWorkflowStrategy is ...

Field Summary

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

NODE_FIRST, PARALLEL, STEP_FIRST

Constructor Summary

Constructors

Constructor and Description
BaseWorkflowStrategy(Framework framework)

Method Summary

Methods

Modifier and Type	Method and Description
protected StepExecutionContext	addNodeStepFailureContextData(StepExecutionResult dispatcherStepResult, StepExecutionContext handlerExecContext) Add any node-specific step failure information to the node-specific data contexts
protected StepExecutionContext	addStepFailureContextData(StepExecutionResult stepResult, StepExecutionContext handlerExecContext) Add step result failure information to the data context
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 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) Execute the sequence of ExecutionItems within the context, and with the given keepgoing value
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) Execute the sequence of ExecutionItems within the context, and with the given keepgoing value
protected WorkflowExecutionListener	getWorkflowListener(ExecutionContext executionContext)
protected static NodeStepResult	nodeStepResultFromNodeStepException(INodeEntry node, NodeStepException nodeStepException)
protected StepExecutionContext	replaceFailedNodesListenerInContext(StepExecutionContext executionContext, FailedNodesListener captureFailedNodesListener)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseWorkflowStrategy

public BaseWorkflowStrategy(Framework framework)

Method Detail

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)

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

Returns:

true if successful

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)

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 StepExecutionContext addStepFailureContextData(StepExecutionResult stepResult,
                                             StepExecutionContext handlerExecContext)

Add step result failure information to the data context

Parameters:

stepResult - result

handlerExecContext - context

Returns:

new context

addNodeStepFailureContextData

protected StepExecutionContext addNodeStepFailureContextData(StepExecutionResult dispatcherStepResult,
                                                 StepExecutionContext handlerExecContext)

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

Parameters:

dispatcherStepResult - result

handlerExecContext - context

Returns:

new context

replaceFailedNodesListenerInContext

protected StepExecutionContext replaceFailedNodesListenerInContext(StepExecutionContext executionContext,
                                                       FailedNodesListener captureFailedNodesListener)

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.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