com.atlassian.bamboo.build
Interface BuildExecutionManager

All Superinterfaces:
BuildExecutionUpdateManager, BuildLoggerManager
All Known Implementing Classes:
DefaultBuildExecutionManager

@ThreadSafe
public interface BuildExecutionManager
extends BuildExecutionUpdateManager, BuildLoggerManager

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


Method Summary
 CurrentlyBuilding addToCurrentlyBuilding(BuildContext buildContext)
          Denotes that the passed build context is beginning the build process.
 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 & finishProcess
 CurrentlyBuilding getBuildRunningOnAgent(java.lang.Long buildAgentId)
           
 java.util.List<CurrentlyBuilding> getCurrentlyBuilding(Key key)
           
 java.util.List<CurrentlyBuilding> getCurrentlyBuilding(java.lang.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(java.lang.String buildResultKey)
          Deprecated. since 4.4 use #getCurrentlyBuildingByPlanResultKey
 CurrentlyBuilding getCurrentlyBuildingByPlanResultKey(ResultKey resultKey)
          Returns CurrentlyBuilding instance for build identified by buildResultKey.
 java.util.List<CurrentlyBuilding> getCurrentlyExecutingBuilds()
          Retrieves a list of all builds being executed (i.e not just queued).
 java.util.List<CurrentlyBuilding> getCurrentlyExecutingBuilds(java.lang.String planKey)
          Retrieves a list of all builds being executed (i.e not just queued) that belong to the specified planKey.
 CurrentlyBuilding removeCurrentlyBuilding(ResultKey resultKey)
           
 CurrentlyBuilding removeCurrentlyBuilding(java.lang.String planKey)
          Deprecated. since 5.0 use $removeCurrentlyBuilding(com.atlassian.bamboo.ResultKey)
 void setCurrentlyBuilding(BuildContext buildContext, java.util.Collection<BuildAgent> executableAgents, java.util.Collection<ElasticImageConfiguration> executableImages)
          Denotes that the passed build context is beginning the build process.
 
Methods inherited from interface com.atlassian.bamboo.build.BuildExecutionUpdateManager
setBuildFinish, setBuildRunningOnAgent, setBuildStart, setBuildStopAcknowledge
 
Methods inherited from interface com.atlassian.bamboo.build.BuildLoggerManager
getBuildLogger, getBuildLogger, getBuildLogger, getLogger, getLogger, removeBuildLogger, removeBuildLogger, removeLogger
 

Method Detail

getCurrentlyExecutingBuilds

@NotNull
java.util.List<CurrentlyBuilding> getCurrentlyExecutingBuilds()
Retrieves a list of all builds being executed (i.e not just queued).

Returns:

getCurrentlyExecutingBuilds

@NotNull
java.util.List<CurrentlyBuilding> getCurrentlyExecutingBuilds(java.lang.String planKey)
Retrieves a list of all builds being executed (i.e not just queued) that belong to the specified planKey.

Parameters:
planKey -
Returns:

getCurrentlyBuilding

@NotNull
@Deprecated
java.util.List<CurrentlyBuilding> getCurrentlyBuilding(@NotNull
                                                                          java.lang.String planKey)
Deprecated. since 5.0 use $getCurrentlyBuilding(com.atlassian.bamboo.Key)

Parameters:
planKey -
Returns:

getCurrentlyBuilding

@NotNull
java.util.List<CurrentlyBuilding> getCurrentlyBuilding(@NotNull
                                                               Key key)

removeCurrentlyBuilding

@Deprecated
@Nullable
CurrentlyBuilding removeCurrentlyBuilding(@NotNull
                                                              java.lang.String planKey)
Deprecated. since 5.0 use $removeCurrentlyBuilding(com.atlassian.bamboo.ResultKey)


removeCurrentlyBuilding

CurrentlyBuilding removeCurrentlyBuilding(@NotNull
                                          ResultKey resultKey)

setCurrentlyBuilding

void setCurrentlyBuilding(@NotNull
                          BuildContext buildContext,
                          @NotNull
                          java.util.Collection<BuildAgent> executableAgents,
                          @NotNull
                          java.util.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.

addToCurrentlyBuilding

CurrentlyBuilding addToCurrentlyBuilding(@NotNull
                                         BuildContext buildContext)
Denotes that the passed build context is beginning the build process. (i.e. it's being queued).

Parameters:
buildContext -

getBuildRunningOnAgent

@Nullable
CurrentlyBuilding getBuildRunningOnAgent(@NotNull
                                                  java.lang.Long buildAgentId)

finishBuild

void finishBuild(@NotNull
                 PlanResultKey planResultKey)
Calls removeCurrentlyBuilding & 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
                                                                           java.lang.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:


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.