com.xebialabs.deployit
Interface StepExecutionContext

public interface StepExecutionContext

Defines a set of methods that a step uses to communicate with its execution engine, e.g. to write to the log file.

Method Summary

java.lang.Object	getAttribute(java.lang.String name) Returns the step execution context attribute with the given name, or null if there is no attribute by that name.
void	logError(java.lang.String error) Logs a line of error output.
void	logOutput(java.lang.String output) Logs a line of output.
void	setAttribute(java.lang.String name, java.lang.Object object) Stores an attribute in the step execution context.

Method Detail

logOutput

void logOutput(java.lang.String output)

Logs a line of output. If this step is executing a command, this would be the output that is sent to the standard output stream.

Parameters:

output - the log line to be written to a destination.

logError

void logError(java.lang.String error)

Logs a line of error output. If this step is executing a command, this would be the output that is sent to the standard error stream.

Parameters:

error - the error to be written to a destination.

getAttribute

java.lang.Object getAttribute(java.lang.String name)

Returns the step execution context attribute with the given name, or null if there is no attribute by that name.

Parameters:

name - the name of the attribute

Returns:

the value of the attribute, or null if there is no attribute by that name.

setAttribute

void setAttribute(java.lang.String name,
                  java.lang.Object object)

Stores an attribute in the step execution context. This attribute will be available while a changeplan is being executed.

Parameters:

name - the name of the attribute

object - the vaule of the attribute