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:

CLIExecutionListener, WorkflowExecutionListenerImpl

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

ExecutionListenerOverrideBase is ...

Constructor Summary

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

Method Summary

void	beginExecuteNodeStep(ExecutionContext context, NodeStepExecutionItem item, INodeEntry node) Begin execution of a node step
void	beginFileCopyFile(ExecutionContext context, 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(ExecutionContext context, StepExecutionItem item) Called when execution begins for a step
void	finishExecuteNodeStep(NodeStepResult result, ExecutionContext context, StepExecutionItem item, INodeEntry node) Finish execution of a node step
void	finishFileCopy(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(StatusResult result, ExecutionContext context, StepExecutionItem item) Called when execution finishes for a step
FailedNodesListener	getFailedNodesListener() Return a listener for failed node list
java.lang.String	getLogFormat() Return log message format
java.util.Map<java.lang.String,java.lang.String>	getLoggingContext() Method should be overridden to return appropriate logging context data
boolean	isTerse() Return true if output should be terse and not prefixed
void	setFailedNodesListener(FailedNodesListener failedNodesListener) Return a listener for failed node list
void	setLogFormat(java.lang.String logFormat) Return log message format
void	setTerse(boolean terse) Return true if output should be terse and not prefixed

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, 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 to return appropriate logging context data

beginStepExecution

public void beginStepExecution(ExecutionContext context,
                               StepExecutionItem item)

Description copied from interface: ExecutionListener

Called when execution begins for a step

Specified by:

beginStepExecution in interface ExecutionListener

finishStepExecution

public void finishStepExecution(StatusResult result,
                                ExecutionContext context,
                                StepExecutionItem item)

Description copied from interface: ExecutionListener

Called when execution finishes for a step

Specified by:

finishStepExecution in interface ExecutionListener

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

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

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

finishNodeDispatch

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

Description copied from interface: ExecutionListener

Finish node dispatch

Specified by:

finishNodeDispatch in interface ExecutionListener

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

finishNodeDispatch

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

Description copied from interface: ExecutionListener

Finish node dispatch

Specified by:

finishNodeDispatch in interface ExecutionListener

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

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

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

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

beginExecuteNodeStep

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

Description copied from interface: ExecutionListener

Begin execution of a node step

Specified by:

beginExecuteNodeStep in interface ExecutionListener

finishExecuteNodeStep

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

Description copied from interface: ExecutionListener

Finish execution of a node step

Specified by:

finishExecuteNodeStep in interface ExecutionListener

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()

Description copied from interface: ExecutionListener

Return true if output should be terse and not prefixed

Specified by:

isTerse in interface ExecutionListener

Returns:

setTerse

public void setTerse(boolean terse)

Description copied from interface: ExecutionListenerOverride

Return true if output should be terse and not prefixed

Specified by:

setTerse in interface ExecutionListenerOverride

getLogFormat

public java.lang.String getLogFormat()

Description copied from interface: ExecutionListener

Return log message format

Specified by:

getLogFormat in interface ExecutionListener

Returns:

setLogFormat

public void setLogFormat(java.lang.String logFormat)

Description copied from interface: ExecutionListenerOverride

Return log message format

Specified by:

setLogFormat in interface ExecutionListenerOverride

setFailedNodesListener

public void setFailedNodesListener(FailedNodesListener failedNodesListener)

Description copied from interface: ExecutionListenerOverride

Return a listener for failed node list

Specified by:

setFailedNodesListener in interface ExecutionListenerOverride