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

Class WorkflowExecutionListenerImpl

java.lang.Object

com.dtolabs.rundeck.core.execution.ExecutionListenerOverrideBase

com.dtolabs.rundeck.core.execution.workflow.WorkflowExecutionListenerImpl

All Implemented Interfaces:

ExecutionListener, ExecutionListenerOverride, ExecutionLogger, WorkflowExecutionListener, PluginLogger

public class WorkflowExecutionListenerImpl
extends ExecutionListenerOverrideBase
implements WorkflowExecutionListener, ExecutionListener

WorkflowExecutionListenerImpl uses the WorkflowExecutionListener methods to maintain workflow execution context data while executing workflows, allowing the ContextLogger to have proper context.

Constructor Summary

Constructors

Modifier	Constructor	Description
	WorkflowExecutionListenerImpl(FailedNodesListener failedNodesListener, ExecutionLogger logger)
protected	WorkflowExecutionListenerImpl(WorkflowExecutionListenerImpl delegate, ExecutionLogger logger)

Method Summary

Modifier and Type	Method	Description
void	beginExecuteNodeStep(ExecutionContext context, NodeStepExecutionItem item, INodeEntry node)	Begin execution of a node step
void	beginWorkflowExecution(StepExecutionContext executionContext, WorkflowExecutionItem item)
void	beginWorkflowItem(int step, StepExecutionItem item)
void	beginWorkflowItemErrorHandler(int step, StepExecutionItem item)
ExecutionListenerOverride	createOverride()
void	event(java.lang.String eventType, java.lang.String message, java.util.Map eventMeta)
void	finishExecuteNodeStep(NodeStepResult result, ExecutionContext context, StepExecutionItem item, INodeEntry node)	Finish execution of a node step
void	finishWorkflowExecution(WorkflowExecutionResult result, StepExecutionContext executionContext, WorkflowExecutionItem item)
void	finishWorkflowItem(int step, StepExecutionItem item, StepExecutionResult result)
void	finishWorkflowItemErrorHandler(int step, StepExecutionItem item, StepExecutionResult result)
ExecutionLogger	getLogger()
void	ignoreErrors(boolean value)	Ignore error messages and transform them into standard output
void	log(int level, java.lang.String message)	Log a message at a given level
void	log(int level, java.lang.String message, java.util.Map eventMeta)	Log a message at a given level, with additional metadata

Methods inherited from class com.dtolabs.rundeck.core.execution.ExecutionListenerOverrideBase

beginFileCopyFile, beginFileCopyFile, beginFileCopyFileStream, beginFileCopyScriptContent, beginNodeDispatch, beginNodeDispatch, beginNodeExecution, beginStepExecution, finishFileCopy, finishMultiFileCopy, finishNodeDispatch, finishNodeDispatch, finishNodeExecution, finishStepExecution, getFailedNodesListener, setFailedNodesListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.dtolabs.rundeck.core.execution.ExecutionListener

beginFileCopyFile, beginFileCopyFile, beginFileCopyFileStream, beginFileCopyScriptContent, beginNodeDispatch, beginNodeDispatch, beginNodeExecution, finishFileCopy, finishMultiFileCopy, finishNodeDispatch, finishNodeDispatch, finishNodeExecution, getFailedNodesListener

Methods inherited from interface com.dtolabs.rundeck.core.execution.ExecutionLogger

event, log, log

Methods inherited from interface com.dtolabs.rundeck.core.execution.workflow.WorkflowExecutionListener

beginStepExecution, finishStepExecution

Constructor Detail

WorkflowExecutionListenerImpl

protected WorkflowExecutionListenerImpl(WorkflowExecutionListenerImpl delegate,
                                        ExecutionLogger logger)

WorkflowExecutionListenerImpl

public WorkflowExecutionListenerImpl(FailedNodesListener failedNodesListener,
                                     ExecutionLogger logger)

Method Detail

ignoreErrors

public void ignoreErrors(boolean value)

Description copied from interface: ExecutionListener

Ignore error messages and transform them into standard output

Specified by:

ignoreErrors in interface ExecutionListener

beginExecuteNodeStep

public void beginExecuteNodeStep(ExecutionContext context,
                                 NodeStepExecutionItem item,
                                 INodeEntry node)

Description copied from interface: WorkflowExecutionListener

Begin execution of a node step

Specified by:

beginExecuteNodeStep in interface WorkflowExecutionListener

Overrides:

beginExecuteNodeStep in class ExecutionListenerOverrideBase

Parameters:

context - context

item - step

node - node

finishExecuteNodeStep

public void finishExecuteNodeStep(NodeStepResult result,
                                  ExecutionContext context,
                                  StepExecutionItem item,
                                  INodeEntry node)

Description copied from interface: WorkflowExecutionListener

Finish execution of a node step

Specified by:

finishExecuteNodeStep in interface WorkflowExecutionListener

Overrides:

finishExecuteNodeStep in class ExecutionListenerOverrideBase

Parameters:

result - result

context - context

item - step

node - node

beginWorkflowExecution

public void beginWorkflowExecution(StepExecutionContext executionContext,
                                   WorkflowExecutionItem item)

Specified by:

beginWorkflowExecution in interface WorkflowExecutionListener

finishWorkflowExecution

public void finishWorkflowExecution(WorkflowExecutionResult result,
                                    StepExecutionContext executionContext,
                                    WorkflowExecutionItem item)

Specified by:

finishWorkflowExecution in interface WorkflowExecutionListener

beginWorkflowItem

public void beginWorkflowItem(int step,
                              StepExecutionItem item)

Specified by:

beginWorkflowItem in interface WorkflowExecutionListener

beginWorkflowItemErrorHandler

public void beginWorkflowItemErrorHandler(int step,
                                          StepExecutionItem item)

Specified by:

beginWorkflowItemErrorHandler in interface WorkflowExecutionListener

finishWorkflowItem

public void finishWorkflowItem(int step,
                               StepExecutionItem item,
                               StepExecutionResult result)

Specified by:

finishWorkflowItem in interface WorkflowExecutionListener

finishWorkflowItemErrorHandler

public void finishWorkflowItemErrorHandler(int step,
                                           StepExecutionItem item,
                                           StepExecutionResult result)

Specified by:

finishWorkflowItemErrorHandler in interface WorkflowExecutionListener

createOverride

public ExecutionListenerOverride createOverride()

Specified by:

createOverride in interface ExecutionListener

Returns:

an ExecutionListenerOverride that will delegate to this ExecutionListener, but allows overriding property values.

event

public void event(java.lang.String eventType,
                  java.lang.String message,
                  java.util.Map eventMeta)

Parameters:

eventType - event type

message - Message being logged. null messages are not logged, however, zero-length strings are.

eventMeta - metadata

log

public void log(int level,
                java.lang.String message)

Description copied from interface: ExecutionLogger

Log a message at a given level

Parameters:

level - the log level, from 0 to 4, where 0 is "error" and 4 is "debug"

message - Message being logged. null messages are not logged, however, zero-length strings are.

log

public void log(int level,
                java.lang.String message,
                java.util.Map eventMeta)

Description copied from interface: ExecutionLogger

Log a message at a given level, with additional metadata

Parameters:

level - the log level, from 0 to 4, where 0 is "error" and 4 is "debug"

message - Message being logged. null messages are not logged, however, zero-length strings are.

eventMeta - metadata

getLogger

public ExecutionLogger getLogger()