com.dtolabs.rundeck.core.execution

Class ExecutionListenerOverrideBase

java.lang.Object

com.dtolabs.rundeck.core.execution.ExecutionListenerOverrideBase

All Implemented Interfaces:

ExecutionListener, ExecutionListenerOverride, PluginLogger

Direct Known Subclasses:

WorkflowExecutionListenerImpl

public abstract class ExecutionListenerOverrideBase
extends java.lang.Object
implements ExecutionListenerOverride

ExecutionListenerOverrideBase is ...

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExecutionListenerOverrideBase(ExecutionListenerOverrideBase delegate)
	ExecutionListenerOverrideBase(FailedNodesListener failedNodesListener, boolean terse, java.lang.String logFormat)

Method Summary

Modifier and Type	Method and Description
void	beginExecuteNodeStep(ExecutionContext context, NodeStepExecutionItem item, INodeEntry node)
void	beginFileCopyFile(ExecutionContext context, java.io.File input, INodeEntry node) Begin file copy of file
void	beginFileCopyFile(ExecutionContext context, java.util.List<java.io.File> input, INodeEntry node) Begin file copy of file
void	beginFileCopyFileStream(ExecutionContext context, java.io.InputStream input, INodeEntry node) Begin file copy of stream
void	beginFileCopyScriptContent(ExecutionContext context, java.lang.String input, INodeEntry node) Begin file copy of string
void	beginNodeDispatch(ExecutionContext context, Dispatchable item) Begin dispatch of command to set of nodes
void	beginNodeDispatch(ExecutionContext context, StepExecutionItem item) Begin dispatch of command to set of nodes
void	beginNodeExecution(ExecutionContext context, java.lang.String[] command, INodeEntry node) Called before execution of command on node
void	beginStepExecution(StepExecutor executor, StepExecutionContext context, StepExecutionItem item)
void	finishExecuteNodeStep(NodeStepResult result, ExecutionContext context, StepExecutionItem item, INodeEntry node)
void	finishFileCopy(java.lang.String result, ExecutionContext context, INodeEntry node) Finish file copy
void	finishMultiFileCopy(java.lang.String[] result, ExecutionContext context, INodeEntry node) Finish file copy
void	finishNodeDispatch(DispatcherResult result, ExecutionContext context, Dispatchable item) Finish node dispatch
void	finishNodeDispatch(DispatcherResult result, ExecutionContext context, StepExecutionItem item) Finish node dispatch
void	finishNodeExecution(NodeExecutorResult result, ExecutionContext context, java.lang.String[] command, INodeEntry node) Called after execution of command on node.
void	finishStepExecution(StepExecutor executor, StatusResult result, StepExecutionContext context, StepExecutionItem item)
FailedNodesListener	getFailedNodesListener() Return a listener for failed node list
java.lang.String	getLogFormat()
java.util.Map<java.lang.String,java.lang.String>	getLoggingContext() Method should be overridden
boolean	isTerse()
void	setFailedNodesListener(FailedNodesListener failedNodesListener)

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

createOverride, event, ignoreErrors, log

Constructor Detail

ExecutionListenerOverrideBase

protected ExecutionListenerOverrideBase(ExecutionListenerOverrideBase delegate)

ExecutionListenerOverrideBase

public ExecutionListenerOverrideBase(FailedNodesListener failedNodesListener,
                                     boolean terse,
                                     java.lang.String logFormat)

Method Detail

getLoggingContext

public java.util.Map<java.lang.String,java.lang.String> getLoggingContext()

Method should be overridden

Returns:

appropriate logging context data

beginStepExecution

public void beginStepExecution(StepExecutor executor,
                               StepExecutionContext context,
                               StepExecutionItem item)

finishStepExecution

public void finishStepExecution(StepExecutor executor,
                                StatusResult result,
                                StepExecutionContext context,
                                StepExecutionItem item)

beginNodeExecution

public void beginNodeExecution(ExecutionContext context,
                               java.lang.String[] command,
                               INodeEntry node)

Description copied from interface: ExecutionListener

Called before execution of command on node

Specified by:

beginNodeExecution in interface ExecutionListener

Parameters:

context - context

command - command strings

node - node

finishNodeExecution

public void finishNodeExecution(NodeExecutorResult result,
                                ExecutionContext context,
                                java.lang.String[] command,
                                INodeEntry node)

Description copied from interface: ExecutionListener

Called after execution of command on node.

Specified by:

finishNodeExecution in interface ExecutionListener

Parameters:

result - result

context - context

command - command strings

node - node

beginNodeDispatch

public void beginNodeDispatch(ExecutionContext context,
                              StepExecutionItem item)

Description copied from interface: ExecutionListener

Begin dispatch of command to set of nodes

Specified by:

beginNodeDispatch in interface ExecutionListener

Parameters:

context - context

item - step

finishNodeDispatch

public void finishNodeDispatch(DispatcherResult result,
                               ExecutionContext context,
                               StepExecutionItem item)

Description copied from interface: ExecutionListener

Finish node dispatch

Specified by:

finishNodeDispatch in interface ExecutionListener

Parameters:

result - result

context - context

item - step

beginNodeDispatch

public void beginNodeDispatch(ExecutionContext context,
                              Dispatchable item)

Description copied from interface: ExecutionListener

Begin dispatch of command to set of nodes

Specified by:

beginNodeDispatch in interface ExecutionListener

Parameters:

context - context

item - dispatch

finishNodeDispatch

public void finishNodeDispatch(DispatcherResult result,
                               ExecutionContext context,
                               Dispatchable item)

Description copied from interface: ExecutionListener

Finish node dispatch

Specified by:

finishNodeDispatch in interface ExecutionListener

Parameters:

result - result

context - context

item - dispatch

beginFileCopyFileStream

public void beginFileCopyFileStream(ExecutionContext context,
                                    java.io.InputStream input,
                                    INodeEntry node)

Description copied from interface: ExecutionListener

Begin file copy of stream

Specified by:

beginFileCopyFileStream in interface ExecutionListener

Parameters:

context - context

input - input stream

node - node

beginFileCopyFile

public void beginFileCopyFile(ExecutionContext context,
                              java.io.File input,
                              INodeEntry node)

Description copied from interface: ExecutionListener

Begin file copy of file

Specified by:

beginFileCopyFile in interface ExecutionListener

Parameters:

context - context

input - file

node - node

beginFileCopyFile

public void beginFileCopyFile(ExecutionContext context,
                              java.util.List<java.io.File> input,
                              INodeEntry node)

Description copied from interface: ExecutionListener

Begin file copy of file

Specified by:

beginFileCopyFile in interface ExecutionListener

Parameters:

context - context

input - files

node - node

beginFileCopyScriptContent

public void beginFileCopyScriptContent(ExecutionContext context,
                                       java.lang.String input,
                                       INodeEntry node)

Description copied from interface: ExecutionListener

Begin file copy of string

Specified by:

beginFileCopyScriptContent in interface ExecutionListener

Parameters:

context - context

input - string

node - node

finishFileCopy

public void finishFileCopy(java.lang.String result,
                           ExecutionContext context,
                           INodeEntry node)

Description copied from interface: ExecutionListener

Finish file copy

Specified by:

finishFileCopy in interface ExecutionListener

Parameters:

result - result

context - context

node - node

finishMultiFileCopy

public void finishMultiFileCopy(java.lang.String[] result,
                                ExecutionContext context,
                                INodeEntry node)

Description copied from interface: ExecutionListener

Finish file copy

Specified by:

finishMultiFileCopy in interface ExecutionListener

Parameters:

result - result

context - context

node - node

beginExecuteNodeStep

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

finishExecuteNodeStep

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

getFailedNodesListener

public FailedNodesListener getFailedNodesListener()

Description copied from interface: ExecutionListener

Return a listener for failed node list

Specified by:

getFailedNodesListener in interface ExecutionListener

Returns:

listener

isTerse

public boolean isTerse()

Specified by:

isTerse in interface ExecutionListener

Returns:

true if output should be terse and not prefixed

getLogFormat

public java.lang.String getLogFormat()

Specified by:

getLogFormat in interface ExecutionListener

Returns:

log message format

setFailedNodesListener

public void setFailedNodesListener(FailedNodesListener failedNodesListener)

Specified by:

setFailedNodesListener in interface ExecutionListenerOverride

Parameters:

failedNodesListener - a listener for failed node list