com.atlassian.bamboo.process

Interface ProcessContext

All Known Implementing Classes:

ProcessContextImpl

public interface ProcessContext

Represents context for running external processes in context of a Bamboo executable. Contains additional information when process is owned by a task.

Method Summary

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

Method Detail

getBuildLogger

@NotNull
BuildLogger getBuildLogger()

Returns:

a build logger for current executable.

getResultKey

@NotNull
ResultKey getResultKey()

Returns:

result key of current execution

getJobDisplayName

@NotNull
String getJobDisplayName()

Returns:

display name of job or environment being executed

getTaskDescription

@NotNull
String getTaskDescription()

Returns:

current task description or empty string if none

getVariableContext

@NotNull
VariableContext getVariableContext()

Returns:

variable context of current execution

getTaskId

long getTaskId()

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.

getTaskPluginKey

@NotNull
String getTaskPluginKey()

Returns:

plugin key of current task or an empty string if none

getCommonContext

@NotNull
CommonContext getCommonContext()

Returns:

execution context of current job/environment

getEnvironment

@NotNull
Map<String,String> getEnvironment()

Returns:

environment variables used for process execution

getPaths

@NotNull
List<String> getPaths()

Returns:

content of "PATH" variable used for process execution

decorateProcessCommand

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

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

Parameters:

command -

Returns:

getTaskContext

@Nullable
CommonTaskContext getTaskContext()

Returns:

current task context or null if not in task context

getBuildKey

@NotNull
BuildKey getBuildKey()

Returns:

unique key of the current context