com.atlassian.bamboo.v2.build.queue
Interface BuildQueueManager

All Known Implementing Classes:

BuildQueueManagerImpl

@ThreadSafe
public interface BuildQueueManager

This interface defines the work that the queue manager can do. Implementors must be threadsafe.

Field Summary

static java.lang.String

DISABLE_BUILD_SYSTEM_PROPERTY

Method Summary

void	addToQueue(CommonContext context) Attempts to add the build to a queue.
com.google.common.collect.ImmutableList<CommonContext>	getBuildQueue() Returns a list of BuildContext objects currently in the build queue.
BuildQueuePosition	getQueuePosition(ResultKey resultKey) Returns information on position of plan result in the queue.
com.google.common.collect.ImmutableList<CommonContext>	getRecentBuildQueue() Returns a list of BuildContext objects currently in the build queue.
boolean	queueContains(PlanKey planKey) Indicates whether a build of a given build plan is in the queue.
void	reconstructBuildQueue() Reconstructs the build queue.
void	removeAllBuildsForPlanFromQueue(PlanKey planKey) Removes all the BuildContext associated with the planKey to be removed from the queue.
void	removeBuildFromQueue(ResultKey resultKey) Removes the CommonContext associated with the resultKey to be removed from the queue.
void	reorderBuildInQueue(java.lang.String planKey, int index) Reorders the build queue.
boolean	reorderBuildInQueue(java.lang.String buildResultKey, java.lang.String prevBuildResultKey, java.lang.String nextBuildResultKey) Moves a given build in a queue in between two given builds.

Field Detail

DISABLE_BUILD_SYSTEM_PROPERTY

static final java.lang.String DISABLE_BUILD_SYSTEM_PROPERTY

See Also:

Constant Field Values

Method Detail

addToQueue

void addToQueue(@NotNull
                CommonContext context)

Attempts to add the build to a queue. A BuildQueuedEvent is fired if queuing was successful and a BuildRejectedFromQueueEvent iif rejected.

A lock on the build is obtained from the BuildExecutionManager.

Parameters:

context - @NotNull

removeBuildFromQueue

void removeBuildFromQueue(@NotNull
                          ResultKey resultKey)

Removes the CommonContext associated with the resultKey to be removed from the queue. A BuildDeQueuedEvent is fired.

The lock on the build is not released. The caller should call BuildExecutionManager#finishProcess to release this lock when ready.

Parameters:

resultKey -

removeAllBuildsForPlanFromQueue

void removeAllBuildsForPlanFromQueue(@NotNull
                                     PlanKey planKey)

Removes all the BuildContext associated with the planKey to be removed from the queue. A BuildDeQueuedEvent is fired.

The lock on the build is not released. The caller should call BuildExecutionManager#finishProcess to release this lock when ready.

Parameters:

planKey -

reorderBuildInQueue

void reorderBuildInQueue(java.lang.String planKey,
                         int index)

Reorders the build queue. BuildContext associated with the planKey is moved to new position in the queue indicated by the zero-based index parameter. If index is < 0 or >= size of queue then BuildContext is positioned at the beginning or at the end of the queue respectively.

Parameters:

planKey - Plan key of the build that shall be repositioned in the queue.

index - New position of a BuildContext associated with the planKey in the queue.

getBuildQueue

@NotNull
com.google.common.collect.ImmutableList<CommonContext> getBuildQueue()

Returns a list of BuildContext objects currently in the build queue. If there are any pending queue operations, this method will block.

Returns:

List of BuildContext. Changes to this List is not reflected in the queue.

getRecentBuildQueue

@NotNull
com.google.common.collect.ImmutableList<CommonContext> getRecentBuildQueue()

Returns a list of BuildContext objects currently in the build queue. If there are any pending queue operations, this method will return the latest known queue state.

Returns:

List of BuildContext. Changes to this List is not reflected in the queue.

queueContains

boolean queueContains(PlanKey planKey)

Indicates whether a build of a given build plan is in the queue.

Parameters:

planKey - The build plan key

Returns:

true if a build of the given build plan is in the queue, false otherwise.

reconstructBuildQueue

void reconstructBuildQueue()

Reconstructs the build queue. This needs to happen in the following scenarios: - Agent capability gets updated - Agent enabled/disabled - Plan configuration (requirements) updated.

reorderBuildInQueue

boolean reorderBuildInQueue(@NotNull
                            java.lang.String buildResultKey,
                            @Nullable
                            java.lang.String prevBuildResultKey,
                            @Nullable
                            java.lang.String nextBuildResultKey)

Moves a given build in a queue in between two given builds. Required because: - By the time a user requests a reorder that plan may already have shifted up the queue (possibly by a considerable number of positions) thus it may be that be reordering to position 3 your may have actually pushed it down the queue rather than up where you wanted it. By reordering between two plans on the queue you basically eliminate this problem. - It allows us to check that the target position of the queue is as the user expects, so we can detect if there was a queue repositioning clash (by another user reordering the queue remotely).

You must specify buildResultKey and either prevBuildResultKey or nextBuildResultKey (or both).

Parameters:

buildResultKey -

prevBuildResultKey -

nextBuildResultKey -

Returns:

true if queue has been successfully reordered and false otherwise (e.g. previous and next builds were not adjacent)

getQueuePosition

@NotNull
BuildQueuePosition getQueuePosition(@NotNull
                                            ResultKey resultKey)

Returns information on position of plan result in the queue.

Parameters:

resultKey - identifies plan result

Returns:

the [@link BuildQueuePosition} object