CommonContext (Atlassian Bamboo 7.2.4 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

BuildContext, DeploymentContext

All Known Implementing Classes:

BuildContextImpl, DeploymentContextImpl, DeploymentRepositoryBuildContext
```
public interface CommonContext
extends Serializable
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CommonArtifactContext`	`getArtifactContext()`
`BuildKey`	`getBuildKey()`
`Map<PlanKey,ChainStorageTag>`	`getChainStorageTags()`
`CurrentResult`	`getCurrentResult()`
`String`	`getDisplayName()` A human friendly description of what is being built.
`DockerPipelineConfiguration`	`getDockerPipelineConfiguration()`
`Long`	`getEntityGroupId()` Returns id of a group entity belongs to.
`long`	`getEntityId()`
`Key`	`getEntityKey()`
`ErrorCollection`	`getErrorCollection()` Any errors associated with the build
`ResultKey`	`getResultKey()`
`List<RuntimeTaskDefinition>`	`getRuntimeTaskDefinitions()` All tasks defined for this build.
`Iterable<CredentialsData>`	`getSharedCredentials()`
`TriggerReason`	`getTriggerReason()` The reason this build was triggered
`VariableContext`	`getVariableContext()`
`List<PlanRepositoryDefinition>`	`getVcsRepositories()`
`Map<Long,PlanRepositoryDefinition>`	`getVcsRepositoryMap()`
`boolean`	`isVerboseLoggingOn()` Controls the amount of logging during the execution.

- Method Detail
  - getBuildKey
```
@NotNull
BuildKey getBuildKey()
```
  - getEntityId
```
long getEntityId()
```
  - getEntityGroupId
```
Long getEntityGroupId()
```
    Returns id of a group entity belongs to. E.g. returns deployment project's id if entity is a deployment environment.
    
    Returns:
    
    id of entity group or null if not applicable.
  - getEntityKey
```
Key getEntityKey()
```
  - getResultKey
```
ResultKey getResultKey()
```
  - getDisplayName
```
String getDisplayName()
```
    A human friendly description of what is being built.
    
    Returns:
  - getCurrentResult
```
CurrentResult getCurrentResult()
```
  - getArtifactContext
```
@NotNull
CommonArtifactContext getArtifactContext()
```
    Returns:
    
    Artifact data associated with Plan
  - getErrorCollection
```
@NotNull
ErrorCollection getErrorCollection()
```
    Any errors associated with the build
  - getRuntimeTaskDefinitions
```
@NotNull
List<RuntimeTaskDefinition> getRuntimeTaskDefinitions()
```
    All tasks defined for this build. Contains both regular tasks and finalising tasks.
    
    Returns:
    
    A List of RuntimeTaskDefinitions
  - getVariableContext
```
@NotNull
VariableContext getVariableContext()
```
  - getTriggerReason
```
@NotNull
TriggerReason getTriggerReason()
```
    The reason this build was triggered
    
    Returns:
    
    triggerReason
  - getVcsRepositoryMap
```
@NotNull
Map<Long,PlanRepositoryDefinition> getVcsRepositoryMap()
```
  - getVcsRepositories
```
@NotNull
List<PlanRepositoryDefinition> getVcsRepositories()
```
  - getSharedCredentials
```
@NotNull
Iterable<CredentialsData> getSharedCredentials()
```
  - getChainStorageTags
```
@NotNull
Map<PlanKey,ChainStorageTag> getChainStorageTags()
```
  - getDockerPipelineConfiguration
```
@NotNull
DockerPipelineConfiguration getDockerPipelineConfiguration()
```
  - isVerboseLoggingOn
```
boolean isVerboseLoggingOn()
```
    Controls the amount of logging during the execution. Some of the logging is only output in verbose mode.
    
    Returns:
    
    true if verbose logging is enabled.
    
    Since:
    
    7.2

Interface CommonContext

Method Summary

Method Detail

getBuildKey

getEntityId

getEntityGroupId

getEntityKey

getResultKey

getDisplayName

getCurrentResult

getArtifactContext

getErrorCollection

getRuntimeTaskDefinitions

getVariableContext

getTriggerReason

getVcsRepositoryMap

getVcsRepositories

getSharedCredentials

getChainStorageTags

getDockerPipelineConfiguration

isVerboseLoggingOn