com.atlassian.bamboo.process

Class ProcessContextImpl

java.lang.Object

com.atlassian.bamboo.process.ProcessContextImpl

All Implemented Interfaces:

ProcessContext

public class ProcessContextImpl
extends Object
implements ProcessContext

Method Summary

Modifier and Type	Method and Description
@NotNull List<String>	decorateProcessCommand(@NotNull List<String> command) Modifies given command by executing command decorators available in the current context.
@NotNull BuildKey	getBuildKey()
@NotNull BuildLogger	getBuildLogger()
@NotNull CommonContext	getCommonContext()
@NotNull Map<String,String>	getEnvironment()
@NotNull String	getJobDisplayName()
@NotNull List<String>	getPaths()
@NotNull ResultKey	getResultKey()
@Nullable CommonTaskContext	getTaskContext()
@NotNull String	getTaskDescription()
long	getTaskId() Returns and id of the current task.
@NotNull String	getTaskPluginKey()
@NotNull VariableContext	getVariableContext()
boolean	isVerboseLoggingOn() Controls the amount of logging during the execution.

Methods inherited from class java.lang.Object

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

Method Detail

getBuildLogger

@NotNull
public @NotNull BuildLogger getBuildLogger()

Specified by:

getBuildLogger in interface ProcessContext

Returns:

a build logger for current executable.

getResultKey

@NotNull
public @NotNull ResultKey getResultKey()

Specified by:

getResultKey in interface ProcessContext

Returns:

result key of current execution

getJobDisplayName

@NotNull
public @NotNull String getJobDisplayName()

Specified by:

getJobDisplayName in interface ProcessContext

Returns:

display name of job or environment being executed

getTaskDescription

@NotNull
public @NotNull String getTaskDescription()

Specified by:

getTaskDescription in interface ProcessContext

Returns:

current task description or empty string if none

getVariableContext

@NotNull
public @NotNull VariableContext getVariableContext()

Specified by:

getVariableContext in interface ProcessContext

Returns:

variable context of current execution

getTaskId

public long getTaskId()

Description copied from interface: ProcessContext

Returns and id of the current task. If not a scope of a task returns a unique number that will not clash with id of any task.

Specified by:

getTaskId in interface ProcessContext

getTaskPluginKey

@NotNull
public @NotNull String getTaskPluginKey()

Specified by:

getTaskPluginKey in interface ProcessContext

Returns:

plugin key of current task or an empty string if none

getCommonContext

@NotNull
public @NotNull CommonContext getCommonContext()

Specified by:

getCommonContext in interface ProcessContext

Returns:

execution context of current job/environment

getTaskContext

@Nullable
public @Nullable CommonTaskContext getTaskContext()

Specified by:

getTaskContext in interface ProcessContext

Returns:

current task context or null if not in task context

getEnvironment

@NotNull
public @NotNull Map<String,String> getEnvironment()

Specified by:

getEnvironment in interface ProcessContext

Returns:

environment variables used for process execution

getPaths

@NotNull
public @NotNull List<String> getPaths()

Specified by:

getPaths in interface ProcessContext

Returns:

content of "PATH" variable used for process execution

getBuildKey

@NotNull
public @NotNull BuildKey getBuildKey()

Specified by:

getBuildKey in interface ProcessContext

Returns:

unique key of the current context

decorateProcessCommand

@NotNull
public @NotNull List<String> decorateProcessCommand(@NotNull
                                                             @NotNull List<String> command)

Description copied from interface: ProcessContext

Modifies given command by executing command decorators available in the current context.

Specified by:

decorateProcessCommand in interface ProcessContext

Returns:

isVerboseLoggingOn

public boolean isVerboseLoggingOn()

Description copied from interface: ProcessContext

Controls the amount of logging during the execution. Some of the logging is only output in verbose mode.

Specified by:

isVerboseLoggingOn in interface ProcessContext

Returns:

true if verbose logging is enabled.