com.atlassian.bamboo.build

Interface BuildExecutionManager

All Known Implementing Classes:

DefaultBuildExecutionManager

@ThreadSafe
public interface BuildExecutionManager

A class that is aware of all the goings on in executing builds.

Method Summary

Modifier and Type	Method and Description
void	execute(BuildContext buildContext) Executes the given BuildContext At this point a BuildResultsSummary exists that matches the given BuildContext
void	finishBuild(PlanResultKey planResultKey) Calls removeCurrentlyBuilding and finishProcess
void	finishBuildWithCleanState(PlanResultKey planResultKey, BuildContext buildContext) Calls removeCurrentlyBuilding and finishProcess.
CurrentlyBuilding	getBuildRunningOnAgent(Long buildAgentId)
List<CurrentlyBuilding>	getCurrentlyBuilding(Key key)
List<CurrentlyBuilding>	getCurrentlyBuilding(String planKey) Deprecated. since 5.0 use getCurrentlyBuilding(com.atlassian.bamboo.Key)
CurrentlyBuilding	getCurrentlyBuildingByBuildResult(BuildIdentifier buildIdentifier) Returns CurrentlyBuilding instance for build identifier (or BuildContext).
CurrentlyBuilding	getCurrentlyBuildingByBuildResultKey(String buildResultKey) Deprecated. since 4.4 use #getCurrentlyBuildingByPlanResultKey
CurrentlyBuilding	getCurrentlyBuildingByPlanResultKey(ResultKey resultKey) Returns CurrentlyBuilding instance for build identified by buildResultKey.
Iterable<CurrentlyBuilding>	getCurrentlyExecuting() Retrieves a all builds being executed (i.e not just queued).
Iterable<CurrentlyBuilding>	getCurrentlyExecuting(PlanKey planKey)
List<CurrentlyBuilding>	getCurrentlyExecutingBuilds() Deprecated. since 5.6 use getCurrentlyExecuting()
List<CurrentlyBuilding>	getCurrentlyExecutingBuilds(String planKey) Deprecated. since 5.6 use getCurrentlyExecuting(com.atlassian.bamboo.plan.PlanKey)
CurrentlyBuilding	removeCurrentlyBuilding(ResultKey resultKey)
CurrentlyBuilding	removeCurrentlyBuilding(String planKey) Deprecated. since 5.0 use removeCurrentlyBuilding(com.atlassian.bamboo.ResultKey)
void	setCurrentlyBuilding(BuildContext buildContext, Collection<BuildAgent> executableAgents, Collection<ElasticImageConfiguration> executableImages) Denotes that the passed build context is beginning the build process.

Method Detail

getCurrentlyExecutingBuilds

@NotNull
 @Deprecated
List<CurrentlyBuilding> getCurrentlyExecutingBuilds()

Deprecated. since 5.6 use getCurrentlyExecuting()

Retrieves a list of all builds being executed (i.e not just queued).

getCurrentlyExecuting

@NotNull
Iterable<CurrentlyBuilding> getCurrentlyExecuting()

Retrieves a all builds being executed (i.e not just queued).

Returns:

getCurrentlyExecutingBuilds

@NotNull
 @Deprecated
List<CurrentlyBuilding> getCurrentlyExecutingBuilds(String planKey)

Deprecated. since 5.6 use getCurrentlyExecuting(com.atlassian.bamboo.plan.PlanKey)

Retrieves a list of all builds being executed (i.e not just queued) that belong to the specified planKey.

getCurrentlyExecuting

Iterable<CurrentlyBuilding> getCurrentlyExecuting(PlanKey planKey)

getCurrentlyBuilding

@NotNull
 @Deprecated
List<CurrentlyBuilding> getCurrentlyBuilding(@NotNull
                                                                   String planKey)

Deprecated. since 5.0 use getCurrentlyBuilding(com.atlassian.bamboo.Key)

Parameters:

planKey -

Returns:

getCurrentlyBuilding

@NotNull
List<CurrentlyBuilding> getCurrentlyBuilding(@NotNull
                                                      Key key)

removeCurrentlyBuilding

@Deprecated
 @Nullable
CurrentlyBuilding removeCurrentlyBuilding(@NotNull
                                                                 String planKey)

Deprecated. since 5.0 use removeCurrentlyBuilding(com.atlassian.bamboo.ResultKey)

removeCurrentlyBuilding

@Nullable
CurrentlyBuilding removeCurrentlyBuilding(@NotNull
                                                    ResultKey resultKey)

setCurrentlyBuilding

void setCurrentlyBuilding(@NotNull
                          BuildContext buildContext,
                          @NotNull
                          Collection<BuildAgent> executableAgents,
                          @NotNull
                          Collection<ElasticImageConfiguration> executableImages)

Denotes that the passed build context is beginning the build process. (i.e. it's being queued)

Parameters:

buildContext - -

executableAgents - - a list of agents on which this build can be run.

executableImages - - a list of images on which the build can be run.

getBuildRunningOnAgent

@Nullable
CurrentlyBuilding getBuildRunningOnAgent(@NotNull
                                                   Long buildAgentId)

finishBuildWithCleanState

void finishBuildWithCleanState(@NotNull
                               PlanResultKey planResultKey,
                               @NotNull
                               BuildContext buildContext)

Calls removeCurrentlyBuilding and finishProcess. This method assumes that result's life cycle state has been updated correctly. If in doubt use finishBuild(PlanResultKey) instead.

Parameters:

planResultKey - identifies plan result

finishBuild

void finishBuild(@NotNull
                 PlanResultKey planResultKey)

Calls removeCurrentlyBuilding and finishProcess

Parameters:

planResultKey - identifies plan result

execute

void execute(@NotNull
             BuildContext buildContext)

Executes the given BuildContext At this point a BuildResultsSummary exists that matches the given BuildContext

Parameters:

buildContext -

getCurrentlyBuildingByBuildResultKey

@Deprecated
 @Nullable
CurrentlyBuilding getCurrentlyBuildingByBuildResultKey(@NotNull
                                                                              String buildResultKey)

Deprecated. since 4.4 use #getCurrentlyBuildingByPlanResultKey

Returns CurrentlyBuilding instance for build identified by buildResultKey. Should be used only if BuildIdentifier is not available - basically in actions

Parameters:

buildResultKey -

Returns:

getCurrentlyBuildingByPlanResultKey

@Nullable
CurrentlyBuilding getCurrentlyBuildingByPlanResultKey(@NotNull
                                                                ResultKey resultKey)

Returns CurrentlyBuilding instance for build identified by buildResultKey. Should be used only if BuildIdentifier is not available - basically in actions

Parameters:

resultKey -

Returns:

getCurrentlyBuildingByBuildResult

@Nullable
CurrentlyBuilding getCurrentlyBuildingByBuildResult(@NotNull
                                                              BuildIdentifier buildIdentifier)

Returns CurrentlyBuilding instance for build identifier (or BuildContext).

Parameters:

buildIdentifier -

Returns: