CommonContext (Atlassian Bamboo 6.0.3 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 Deprecated Methods
Modifier and Type	Method and Description
`BuildKey`	`getBuildKey()`
`Map<PlanKey,ChainStorageTag>`	`getChainStorageTags()`
`CurrentResult`	`getCurrentResult()`
`String`	`getDisplayName()` A human friendly description of what is being built.
`long`	`getEntityId()`
`Key`	`getEntityKey()`
`ErrorCollection`	`getErrorCollection()` Any errors associated with the build
`Map<Long,RepositoryDefinition>`	`getRepositoryDefinitionMap()` Deprecated. since 5.14 use `getVcsRepositoryMap()`
`List<RepositoryDefinition>`	`getRepositoryDefinitions()` Deprecated. since 5.14 use `getVcsRepositories()`
`ResultKey`	`getResultKey()`
`RuntimeTaskContext`	`getRuntimeTaskContext()` Deprecated. since 5.9 without direct replacement. Use `RuntimeTaskDefinition` to access this information.
`List<RuntimeTaskDefinition>`	`getRuntimeTaskDefinitions()` All tasks defined for this build.
`Iterable<CredentialsData>`	`getSharedCredentials()`
`List<TaskDefinition>`	`getTaskDefinitions()` Deprecated. since 5.9 use `getRuntimeTaskDefinitions()`
`TriggerReason`	`getTriggerReason()` The reason this build was triggered
`VariableContext`	`getVariableContext()`
`List<PlanRepositoryDefinition>`	`getVcsRepositories()`
`Map<Long,PlanRepositoryDefinition>`	`getVcsRepositoryMap()`

- Method Detail
  - getBuildKey
```
@NotNull
BuildKey getBuildKey()
```
  - getEntityId
```
long getEntityId()
```
  - getEntityKey
```
Key getEntityKey()
```
  - getResultKey
```
ResultKey getResultKey()
```
  - getDisplayName
```
String getDisplayName()
```
    A human friendly description of what is being built.
    
    Returns:
  - getCurrentResult
```
CurrentResult getCurrentResult()
```
  - getErrorCollection
```
@NotNull
ErrorCollection getErrorCollection()
```
    Any errors associated with the build
  - getTaskDefinitions
```
@NotNull
 @Deprecated
List<TaskDefinition> getTaskDefinitions()
```
    Deprecated. since 5.9 use getRuntimeTaskDefinitions()
    
    All tasks defined for this build. Contains both regular tasks and finalising tasks.
    
    Returns:
    
    A List of TaskDefinitions
  - getRuntimeTaskDefinitions
```
@NotNull
List<RuntimeTaskDefinition> getRuntimeTaskDefinitions()
```
    All tasks defined for this build. Contains both regular tasks and finalising tasks.
    
    Returns:
    
    A List of RuntimeTaskDefinitions
  - getRuntimeTaskContext
```
@NotNull
 @Deprecated
RuntimeTaskContext getRuntimeTaskContext()
```
    Deprecated. since 5.9 without direct replacement. Use RuntimeTaskDefinition to access this information.
    
    Runtime context for the tasks executed for given build context This context is set by pluggable RuntimeTaskDataProvider.populateRuntimeTaskData(TaskDefinition, CommonContext)
    
    Returns:
  - getVariableContext
```
@NotNull
VariableContext getVariableContext()
```
  - getTriggerReason
```
@NotNull
TriggerReason getTriggerReason()
```
    The reason this build was triggered
    
    Returns:
    
    triggerReason
  - getRepositoryDefinitionMap
```
@Deprecated
 @NotNull
Map<Long,RepositoryDefinition> getRepositoryDefinitionMap()
```
    Deprecated. since 5.14 use getVcsRepositoryMap()
  - getRepositoryDefinitions
```
@Deprecated
 @NotNull
List<RepositoryDefinition> getRepositoryDefinitions()
```
    Deprecated. since 5.14 use getVcsRepositories()
  - getVcsRepositoryMap
```
@NotNull
Map<Long,PlanRepositoryDefinition> getVcsRepositoryMap()
```
  - getVcsRepositories
```
@NotNull
List<PlanRepositoryDefinition> getVcsRepositories()
```
  - getSharedCredentials
```
@NotNull
Iterable<CredentialsData> getSharedCredentials()
```
  - getChainStorageTags
```
@NotNull
Map<PlanKey,ChainStorageTag> getChainStorageTags()
```

Interface CommonContext

Method Summary

Method Detail

getBuildKey

getEntityId

getEntityKey

getResultKey

getDisplayName

getCurrentResult

getErrorCollection

getTaskDefinitions

getRuntimeTaskDefinitions

getRuntimeTaskContext

getVariableContext

getTriggerReason

getRepositoryDefinitionMap

getRepositoryDefinitions

getVcsRepositoryMap

getVcsRepositories

getSharedCredentials

getChainStorageTags