Package com.atlassian.bamboo.deployments.execution

Class DeploymentContextImpl

java.lang.Object

com.atlassian.bamboo.deployments.execution.DeploymentContextImpl

All Implemented Interfaces:

DeploymentContext, CommonContext, Serializable

public class DeploymentContextImpl
extends Object
implements DeploymentContext

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor

Description

DeploymentContextImpl(@NotNull DeploymentProject deploymentProject, @NotNull DeploymentResult deploymentResult, @NotNull List<TaskDefinition> taskDefinitions, @NotNull Map<String,String> artifactHandlerConfiguration, @NotNull VariableContext variableContext, Map<Long,PlanRepositoryDefinition> planRepositoryDefinitionMap, Multimap<String,Artifact> versionArtifacts, @Nullable DeploymentVersion previousVersion, @NotNull Iterable<CredentialsData> sharedCredentials, @NotNull Map<PlanKey,ChainStorageTag> necessaryStorageTags, @NotNull Map<String,Map<String,String>> pluginConfigMap, @NotNull DockerPipelineConfiguration dockerPipelineConfiguration, @NotNull CommonArtifactContext commonArtifactContext, boolean isVerboseLoggingOn, boolean expectingDedicatedEphemeralAgent)

Method Summary

Modifier and Type	Method	Description
@NotNull CommonArtifactContext	getArtifactContext()
@NotNull Map<String,String>	getArtifactHandlerConfiguration()
@NotNull BuildKey	getBuildKey()
@NotNull Map<PlanKey,ChainStorageTag>	getChainStorageTags()
CurrentResult	getCurrentResult()
long	getDeploymentProjectId()
@NotNull String	getDeploymentProjectName()
long	getDeploymentResultId()
@NotNull DeploymentVersion	getDeploymentVersion()
String	getDisplayName()	A human friendly description of what is being built.
@NotNull DockerPipelineConfiguration	getDockerPipelineConfiguration()
Long	getEntityGroupId()	Returns id of a group entity belongs to.
long	getEntityId()
@NotNull Key	getEntityKey()
long	getEnvironmentId()
@NotNull String	getEnvironmentName()
@NotNull ErrorCollection	getErrorCollection()	Any errors associated with the build
@NotNull Map<String,String>	getPluginConfigMap(String key)	Returns configuration map that is mapped to provided key.
@Nullable String	getPreviousVersionName()
@NotNull ResultKey	getResultKey()
@NotNull List<RuntimeTaskDefinition>	getRuntimeTaskDefinitions()	All tasks defined for this build.
@NotNull Iterable<CredentialsData>	getSharedCredentials()
@NotNull TriggerReason	getTriggerReason()	The reason this build was triggered
@NotNull VariableContext	getVariableContext()
@NotNull List<PlanRepositoryDefinition>	getVcsRepositories()
@NotNull Map<Long,PlanRepositoryDefinition>	getVcsRepositoryMap()
@NotNull ArtifactMultimap	getVersionArtifacts()
boolean	isExpectingCustomDedicatedAgent()	If this job is expected to be built on a custom dedicated agent
boolean	isRollback()
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

Constructor Details

DeploymentContextImpl

public DeploymentContextImpl(@NotNull
 @NotNull DeploymentProject deploymentProject,
 @NotNull
 @NotNull DeploymentResult deploymentResult,
 @NotNull
 @NotNull List<TaskDefinition> taskDefinitions,
 @NotNull
 @NotNull Map<String,String> artifactHandlerConfiguration,
 @NotNull
 @NotNull VariableContext variableContext,
 Map<Long,PlanRepositoryDefinition> planRepositoryDefinitionMap,
 Multimap<String,Artifact> versionArtifacts,
 @Nullable
 @Nullable DeploymentVersion previousVersion,
 @NotNull
 @NotNull Iterable<CredentialsData> sharedCredentials,
 @NotNull
 @NotNull Map<PlanKey,ChainStorageTag> necessaryStorageTags,
 @NotNull
 @NotNull Map<String,Map<String,String>> pluginConfigMap,
 @NotNull
 @NotNull DockerPipelineConfiguration dockerPipelineConfiguration,
 @NotNull
 @NotNull CommonArtifactContext commonArtifactContext,
 boolean isVerboseLoggingOn,
 boolean expectingDedicatedEphemeralAgent)

Method Details

getBuildKey

@NotNull
public @NotNull BuildKey getBuildKey()

Specified by:

getBuildKey in interface CommonContext

getVcsRepositories

@NotNull
public @NotNull List<PlanRepositoryDefinition> getVcsRepositories()

Specified by:

getVcsRepositories in interface CommonContext

getVcsRepositoryMap

@NotNull
public @NotNull Map<Long,PlanRepositoryDefinition> getVcsRepositoryMap()

Specified by:

getVcsRepositoryMap in interface CommonContext

getDeploymentResultId

public long getDeploymentResultId()

Specified by:

getDeploymentResultId in interface DeploymentContext

getEnvironmentId

public long getEnvironmentId()

Specified by:

getEnvironmentId in interface DeploymentContext

getEntityGroupId

public Long getEntityGroupId()

Description copied from interface: CommonContext

Returns id of a group entity belongs to. E.g. returns deployment project's id if entity is a deployment environment.

Specified by:

getEntityGroupId in interface CommonContext

Returns:

id of entity group or null if not applicable.

getDeploymentProjectId

public long getDeploymentProjectId()

Specified by:

getDeploymentProjectId in interface DeploymentContext

getEntityId

public long getEntityId()

Specified by:

getEntityId in interface CommonContext

getEntityKey

@NotNull
public @NotNull Key getEntityKey()

Specified by:

getEntityKey in interface CommonContext

getResultKey

@NotNull
public @NotNull ResultKey getResultKey()

Specified by:

getResultKey in interface CommonContext

getDisplayName

public String getDisplayName()

Description copied from interface: CommonContext

A human friendly description of what is being built.

Specified by:

getDisplayName in interface CommonContext

Returns:

getCurrentResult

public CurrentResult getCurrentResult()

Specified by:

getCurrentResult in interface CommonContext

getDeploymentVersion

@NotNull
public @NotNull DeploymentVersion getDeploymentVersion()

Specified by:

getDeploymentVersion in interface DeploymentContext

getErrorCollection

@NotNull
public @NotNull ErrorCollection getErrorCollection()

Description copied from interface: CommonContext

Any errors associated with the build

Specified by:

getErrorCollection in interface CommonContext

getRuntimeTaskDefinitions

@NotNull
public @NotNull List<RuntimeTaskDefinition> getRuntimeTaskDefinitions()

Description copied from interface: CommonContext

All tasks defined for this build. Contains both regular tasks and finalising tasks.

Specified by:

getRuntimeTaskDefinitions in interface CommonContext

Returns:

A List of RuntimeTaskDefinitions

getVariableContext

@NotNull
public @NotNull VariableContext getVariableContext()

Specified by:

getVariableContext in interface CommonContext

getArtifactHandlerConfiguration

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

Specified by:

getArtifactHandlerConfiguration in interface DeploymentContext

getTriggerReason

@NotNull
public @NotNull TriggerReason getTriggerReason()

Description copied from interface: CommonContext

The reason this build was triggered

Specified by:

getTriggerReason in interface CommonContext

Returns:

triggerReason

getVersionArtifacts

@NotNull
public @NotNull ArtifactMultimap getVersionArtifacts()

Specified by:

getVersionArtifacts in interface DeploymentContext

getDeploymentProjectName

@NotNull
public @NotNull String getDeploymentProjectName()

Specified by:

getDeploymentProjectName in interface DeploymentContext

getEnvironmentName

@NotNull
public @NotNull String getEnvironmentName()

Specified by:

getEnvironmentName in interface DeploymentContext

isRollback

public boolean isRollback()

Specified by:

isRollback in interface DeploymentContext

getPreviousVersionName

@Nullable
public @Nullable String getPreviousVersionName()

Specified by:

getPreviousVersionName in interface DeploymentContext

getPluginConfigMap

@NotNull
public @NotNull Map<String,String> getPluginConfigMap(String key)

Description copied from interface: DeploymentContext

Returns configuration map that is mapped to provided key. Plugins can change its context during deployment execution. Any changes made to this map are not saved in database.

Specified by:

getPluginConfigMap in interface DeploymentContext

Parameters:

key - CustomEnvironmentConfigPlugin full plugin key

Returns:

configuration map

getDockerPipelineConfiguration

@NotNull
public @NotNull DockerPipelineConfiguration getDockerPipelineConfiguration()

Specified by:

getDockerPipelineConfiguration in interface CommonContext

getSharedCredentials

@NotNull
public @NotNull Iterable<CredentialsData> getSharedCredentials()

Specified by:

getSharedCredentials in interface CommonContext

getChainStorageTags

@NotNull
public @NotNull Map<PlanKey,ChainStorageTag> getChainStorageTags()

Specified by:

getChainStorageTags in interface CommonContext

getArtifactContext

@NotNull
public @NotNull CommonArtifactContext getArtifactContext()

Specified by:

getArtifactContext in interface CommonContext

Returns:

Artifact data associated with plan or deployment

isVerboseLoggingOn

public boolean isVerboseLoggingOn()

Description copied from interface: CommonContext

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

Specified by:

isVerboseLoggingOn in interface CommonContext

Returns:

true if verbose logging is enabled.

isExpectingCustomDedicatedAgent

public boolean isExpectingCustomDedicatedAgent()

Description copied from interface: CommonContext

If this job is expected to be built on a custom dedicated agent

Specified by:

isExpectingCustomDedicatedAgent in interface CommonContext