com.xebialabs.deployit.plugin.api.flow

Interface ExecutionContext

public interface ExecutionContext

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.String name) Returns the execution context attribute with the given name, or null if there is no attribute by that name.
InspectionContext	getInspectionContext()
Repository	getRepository() Returns the repository where all the ConfigurationItems known in XL Deploy are stored.
ITask	getTask() Returns the task of the current execution context.
void	logError(java.lang.String error) Logs a line of error output.
void	logError(java.lang.String error, java.lang.Throwable t) Logs a line and an exception to the error output .
void	logOutput(java.lang.String output) Logs a line of output.
void	setAttribute(java.lang.String name, java.lang.Object value) Stores an attribute in the 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.

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 line to be written.

logError

void logError(java.lang.String error,
            java.lang.Throwable t)

Logs a line and an exception to the error output .

Parameters:

error - the error to be written.

t - the exception to be logged too

getAttribute

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

Returns the 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 value)

Stores an attribute in the execution context. This attribute will be available while the deployment plan is executing, until it is stopped or finished.

Parameters:

name - the name of the attribute

value - the value of the attribute

getRepository

Repository getRepository()

Returns the repository where all the ConfigurationItems known in XL Deploy are stored. Note: The repository cannot be stored in a step, as it is not Serializable.

Returns:

the repository

getInspectionContext

InspectionContext getInspectionContext()

getTask

ITask getTask()

Returns the task of the current execution context.

Returns:

the task