com.atlassian.bamboo.v2.build.queue

Interface BuildQueueManager

All Superinterfaces:

AgentQueueAccessor

All Known Implementing Classes:

BuildQueueManagerImpl

@Internal
 @ThreadSafe
public interface BuildQueueManager
extends AgentQueueAccessor

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BuildQueueManager.QueuedResultKey
static class	BuildQueueManager.QueueItemView<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLE_BUILD_SYSTEM_PROPERTY

Method Summary

Modifier and Type	Method and Description
void	addToQueue(CommonContext context) Attempts to add the build to a queue.
Set<Long>	getExecutorsForQueuedExecutable(ResultKey resultKey)
Collection<ElasticImageConfiguration>	getImagesForQueuedExecutable(ResultKey resultKey)
Iterable<BuildQueueManager.QueuedResultKey>	getQueuedExecutables()
BuildQueuePosition	getQueuePosition(ResultKey resultKey) Returns information on position of plan result in the queue.
void	invalidateExecutables(BuildAgent buildAgent) Updates all agent-executable mappings for a given agent.
void	invalidateExecutors(Key planKey)
void	invalidateExecutors(String reason)
BuildQueueManager.QueueItemView<CommonContext>	peekContext(ResultKey resultKey) Returns a queued CommonContext for given resultKey.
void	removeBuildFromQueue(ResultKey resultKey) Removes the CommonContext associated with the resultKey to be removed from the queue.
boolean	reorderInQueue(ResultKey resultKey, int index) Reorders the build queue.
void	restoreState(Set<ResultKey> resultsToRestore) Restore state after server restart.

Methods inherited from interface com.atlassian.bamboo.v2.build.queue.AgentQueueAccessor

takeBuildContext

Field Detail

DISABLE_BUILD_SYSTEM_PROPERTY

static final 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 com.atlassian.bamboo.v2.build.events.BuildQueuedEvent is fired if queuing was successful

A lock on the build is obtained from the BuildExecutionManager.

Parameters:

context -

Throws:

{@link - IllegalStateException} if the build is already queued

removeBuildFromQueue

void removeBuildFromQueue(@NotNull
                          ResultKey resultKey)

Removes the CommonContext associated with the resultKey to be removed from the queue.

The lock on the build is not released. The caller should call com.atlassian.bamboo.build.BuildExecutionManager#finishBuild(PlanResultKey) to release this lock when ready.

Parameters:

resultKey -

peekContext

@Nullable
BuildQueueManager.QueueItemView<CommonContext> peekContext(@NotNull
                                                                     ResultKey resultKey)

Returns a queued CommonContext for given resultKey. Consider using com.atlassian.bamboo.v2.build.queue.QueueManagerView for your build queue viewing needs}

Parameters:

resultKey -

Returns:

reorderInQueue

boolean reorderInQueue(ResultKey resultKey,
                       int index)

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

Parameters:

resultKey - Result key of the build that shall be repositioned in the queue.

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

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

invalidateExecutors

void invalidateExecutors(@NotNull
                         String reason)

invalidateExecutors

void invalidateExecutors(@NotNull
                         Key planKey)

invalidateExecutables

void invalidateExecutables(@NotNull
                           BuildAgent buildAgent)

Updates all agent-executable mappings for a given agent.

getQueuedExecutables

@NotNull
Iterable<BuildQueueManager.QueuedResultKey> getQueuedExecutables()

Returns:

the currently queued executables.

getImagesForQueuedExecutable

@Nullable
Collection<ElasticImageConfiguration> getImagesForQueuedExecutable(@NotNull
                                                                             ResultKey resultKey)

Returns:

the images that can execute the given executable. returns null if the executable is unknown.

getExecutorsForQueuedExecutable

@Nullable
Set<Long> getExecutorsForQueuedExecutable(@NotNull
                                                    ResultKey resultKey)

Returns:

the ids of agents that can execute the given executable. returns null if the executable is unknown.

restoreState

void restoreState(Set<ResultKey> resultsToRestore)

Restore state after server restart.

Parameters:

resultsToRestore - keys of results that it makes sense to restore