Package com.atlassian.bamboo.v2.build

Class BuildContextImpl

java.lang.Object

com.atlassian.bamboo.v2.build.BuildIdentifierImpl

com.atlassian.bamboo.v2.build.BuildContextImpl

All Implemented Interfaces:

BuildContext, BuildIdentifier, CommonContext, Serializable

public class BuildContextImpl
extends BuildIdentifierImpl
implements BuildContext

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

BuildContextImpl(BuildIdentifier identifier, TriggerReason triggerReason, BuildDefinition buildDefinition, @Nullable BuildChanges buildChanges, @Nullable BuildContext parentBuildContext, @Nullable ArtifactContext artifactContext, VariableContext variableContext, @Nullable Map<String,String> customBuildData, Map<Long,PlanRepositoryDefinition> planRepositoryDefinitionMap, Set<Long> relevantRepositoryIds, Map<Long,String> checkoutLocation, boolean isBranch, boolean isOnceOff, boolean isCustomBuild, boolean isVerboseLoggingOn, BambooBandanaContext bandanaContext, @NotNull Iterable<CredentialsData> relevantSharedCredentials, @NotNull Map<PlanKey,ChainStorageTag> relevantStorageTags, BuildKey buildKey, MergeResultContext mergeResult, boolean expectingCustomDedicatedAgent)

Using this constructor directly is not recommended.

Method Summary

Modifier and Type	Method	Description
@NotNull ArtifactContext	getArtifactContext()
@NotNull BambooBandanaContext	getBandanaContext()	BandanaContext of the plan.
@NotNull BuildChanges	getBuildChanges()	Returns the build changes, if any, that represents the changes that triggered this build.
@NotNull BuildDefinition	getBuildDefinition()
@NotNull BuildKey	getBuildKey()
@NotNull CurrentBuildResult	getBuildResult()	The information about the results of a build
@NotNull Map<PlanKey,ChainStorageTag>	getChainStorageTags()
@NotNull Map<Long,String>	getCheckoutLocation()	Map holds final checkout where repository was checked out by VcsCheckoutTask Elements are kept in order of checkout
@NotNull CurrentResult	getCurrentResult()
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()
Key	getEntityKey()
@NotNull ErrorCollection	getErrorCollection()	Any errors associated with the build
long	getMaximumBuildWarningsCount()
MergeResultContext	getMergeResult()	If a build performs merge, this method returns the result.
BuildContext	getParentBuildContext()	If this context is for ImmutableJob returns context of owner chain, null otherwise.
BuildIdentifier	getParentBuildIdentifier()
@NotNull Set<Long>	getRelevantRepositoryIds()
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()
boolean	isBranch()	Provides information if context refers to the branch of the Chain
boolean	isCustomBuild()	Provides information if context refers to the build that had some variables overwritten
boolean	isExpectingCustomDedicatedAgent()	If this job is expected to be built on a custom dedicated agent
boolean	isOnceOff()	Provides information if context refers to the "once-off" build - a build that have been run with customized revision
boolean	isVerboseLoggingOn()	Controls the amount of logging during the execution.
void	setBuildChanges(BuildChanges buildChanges)
void	setMergeResult(MergeResultContext mergeResultSummary)
void	setRelevantRepositories(@NotNull Set<RepositoryDefinition> relevantRepositories)
void	setVariableContext(VariableContext variableContext)

Methods inherited from class com.atlassian.bamboo.v2.build.BuildIdentifierImpl

equals, getBuildNumber, getBuildResultKey, getMasterPlanId, getPlanDbId, getPlanId, getPlanKey, getPlanName, getPlanResultKey, getProjectName, getShortName, getTypedPlanKey, getUuid, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.v2.build.BuildIdentifier

getBuildNumber, getBuildResultKey, getMasterPlanId, getPlanDbId, getPlanId, getPlanKey, getPlanName, getPlanResultKey, getProjectName, getShortName, getTypedPlanKey, getUuid

Constructor Detail

BuildContextImpl

public BuildContextImpl(BuildIdentifier identifier,
                        TriggerReason triggerReason,
                        BuildDefinition buildDefinition,
                        @Nullable
                        @Nullable BuildChanges buildChanges,
                        @Nullable
                        @Nullable BuildContext parentBuildContext,
                        @Nullable
                        @Nullable ArtifactContext artifactContext,
                        VariableContext variableContext,
                        @Nullable
                        @Nullable Map<String,String> customBuildData,
                        Map<Long,PlanRepositoryDefinition> planRepositoryDefinitionMap,
                        Set<Long> relevantRepositoryIds,
                        Map<Long,String> checkoutLocation,
                        boolean isBranch,
                        boolean isOnceOff,
                        boolean isCustomBuild,
                        boolean isVerboseLoggingOn,
                        BambooBandanaContext bandanaContext,
                        @NotNull
                        @NotNull Iterable<CredentialsData> relevantSharedCredentials,
                        @NotNull
                        @NotNull Map<PlanKey,ChainStorageTag> relevantStorageTags,
                        BuildKey buildKey,
                        MergeResultContext mergeResult,
                        boolean expectingCustomDedicatedAgent)

Using this constructor directly is not recommended. Use BuildContextBuilder instead.

Method Detail

getBuildKey

@NotNull
public @NotNull BuildKey getBuildKey()

Specified by:

getBuildKey in interface CommonContext

getParentBuildIdentifier

public BuildIdentifier getParentBuildIdentifier()

Specified by:

getParentBuildIdentifier in interface BuildIdentifier

Overrides:

getParentBuildIdentifier in class BuildIdentifierImpl

Returns:

the BuildContext of the parent Plan execution. Should return null if the current BuildContext is for a Chain

getParentBuildContext

public BuildContext getParentBuildContext()

Description copied from interface: BuildContext

If this context is for ImmutableJob returns context of owner chain, null otherwise. Note: modifying parent context by job-level actions, such as PreJobAction is not thread safe and is not supported.

Specified by:

getParentBuildContext in interface BuildContext

Returns:

the BuildContext of the parent Plan execution. Should return null if the current BuildContext is for a TopLevelPlan

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

getBuildDefinition

@NotNull
public @NotNull BuildDefinition getBuildDefinition()

Specified by:

getBuildDefinition in interface BuildContext

Returns:

BuildDefinition associated with Plan this context relates to

getBuildChanges

@NotNull
public @NotNull BuildChanges getBuildChanges()

Description copied from interface: BuildContext

Returns the build changes, if any, that represents the changes that triggered this build.

Specified by:

getBuildChanges in interface BuildContext

Returns:

Never null. WIll return a build changes object with the appropriate list of changes, the list will be null if no changes were found.

setBuildChanges

public void setBuildChanges(BuildChanges buildChanges)

Specified by:

setBuildChanges in interface BuildContext

getBuildResult

@NotNull
public @NotNull CurrentBuildResult getBuildResult()

Description copied from interface: BuildContext

The information about the results of a build

Specified by:

getBuildResult in interface BuildContext

Returns:

CurrentBuildResult

getCurrentResult

@NotNull
public @NotNull CurrentResult getCurrentResult()

Specified by:

getCurrentResult in interface CommonContext

getArtifactContext

@NotNull
public @NotNull ArtifactContext getArtifactContext()

Specified by:

getArtifactContext in interface BuildContext

Specified by:

getArtifactContext in interface CommonContext

Returns:

Artifact data associated with Plan

getVariableContext

@NotNull
public @NotNull VariableContext getVariableContext()

Specified by:

getVariableContext 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

getCheckoutLocation

@NotNull
public @NotNull Map<Long,String> getCheckoutLocation()

Description copied from interface: BuildContext

Map holds final checkout where repository was checked out by VcsCheckoutTask Elements are kept in order of checkout

Specified by:

getCheckoutLocation in interface BuildContext

Returns:

map of repositoryId as Long and checkout location as String

isBranch

public boolean isBranch()

Description copied from interface: BuildContext

Provides information if context refers to the branch of the Chain

Specified by:

isBranch in interface BuildContext

Returns:

true if context refers to the chain branch

isOnceOff

public boolean isOnceOff()

Description copied from interface: BuildContext

Provides information if context refers to the "once-off" build - a build that have been run with customized revision

Specified by:

isOnceOff in interface BuildContext

Returns:

true if context refers to the chain branch

isCustomBuild

public boolean isCustomBuild()

Description copied from interface: BuildContext

Provides information if context refers to the build that had some variables overwritten

Specified by:

isCustomBuild in interface BuildContext

Returns:

true if context refers to the build with overwritten variables

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.

getBandanaContext

@NotNull
public @NotNull BambooBandanaContext getBandanaContext()

Description copied from interface: BuildContext

BandanaContext of the plan.

Specified by:

getBandanaContext in interface BuildContext

Returns:

BandanaContext of the plan

getErrorCollection

@NotNull
public @NotNull ErrorCollection getErrorCollection()

Description copied from interface: CommonContext

Any errors associated with the build

Specified by:

getErrorCollection in interface CommonContext

setRelevantRepositories

public void setRelevantRepositories(@NotNull
                                    @NotNull Set<RepositoryDefinition> relevantRepositories)

getRelevantRepositoryIds

@NotNull
public @NotNull Set<Long> getRelevantRepositoryIds()

Specified by:

getRelevantRepositoryIds in interface BuildContext

Returns:

a set of repository id's that are relevant to this particular job, i.e. these jobs do checkout of that repository

getEntityKey

public Key getEntityKey()

Specified by:

getEntityKey in interface CommonContext

getResultKey

public 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:

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

getEntityId

public long getEntityId()

Specified by:

getEntityId 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

setVariableContext

public void setVariableContext(VariableContext variableContext)

Specified by:

setVariableContext in interface BuildContext

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.

getDockerPipelineConfiguration

@NotNull
public @NotNull DockerPipelineConfiguration getDockerPipelineConfiguration()

Specified by:

getDockerPipelineConfiguration in interface CommonContext

getMaximumBuildWarningsCount

public long getMaximumBuildWarningsCount()

Specified by:

getMaximumBuildWarningsCount in interface BuildContext

getMergeResult

public MergeResultContext getMergeResult()

Description copied from interface: BuildContext

If a build performs merge, this method returns the result.

Specified by:

getMergeResult in interface BuildContext

setMergeResult

public void setMergeResult(MergeResultContext mergeResultSummary)

Specified by:

setMergeResult in interface BuildContext

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