com.atlassian.bamboo.v2.build.queue

Class BuildQueueManagerImpl

java.lang.Object

com.atlassian.bamboo.v2.build.queue.BuildQueueManagerImpl

All Implemented Interfaces:

AgentQueueAccessor, BuildQueueManager

public class BuildQueueManagerImpl
extends Object
implements BuildQueueManager

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.v2.build.queue.BuildQueueManager

BuildQueueManager.QueuedResultKey, BuildQueueManager.QueueItemView<T>

Nested classes/interfaces inherited from interface com.atlassian.bamboo.v2.build.queue.AgentQueueAccessor

AgentQueueAccessor.QueueAccessResult

Field Summary

Fields inherited from interface com.atlassian.bamboo.v2.build.queue.BuildQueueManager

DISABLE_BUILD_SYSTEM_PROPERTY

Constructor Summary

Constructors

Constructor and Description

BuildQueueManagerImpl(AgentManager agentManager, com.atlassian.event.api.EventPublisher eventPublisher, BuildExecutionManager buildExecutionManager, com.atlassian.plugin.PluginAccessor pluginAccessor, ErrorUpdateHandler errorUpdateHandler, ExecutableAgentsHelper executableAgentsHelper, CustomVariableContextRunner customVariableContextRunner, ExecutionPhaseService executionPhaseService, XStreamFactory xStreamFactory, org.springframework.transaction.support.TransactionTemplate transactionTemplate, LocalResultProcessor resultProcessor)

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 key)
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.
CommonContext	takeBuildContext(long agentId) Takes a CommonContext from the queue, blocking until one is available.
AgentQueueAccessor.QueueAccessResult	takeContext(long agentId) Takes a CommonContext from the queue, blocking until one is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildQueueManagerImpl

@Inject
public BuildQueueManagerImpl(@NotNull
                                     AgentManager agentManager,
                                     @NotNull
                                     com.atlassian.event.api.EventPublisher eventPublisher,
                                     @NotNull
                                     BuildExecutionManager buildExecutionManager,
                                     @NotNull
                                     com.atlassian.plugin.PluginAccessor pluginAccessor,
                                     @NotNull
                                     ErrorUpdateHandler errorUpdateHandler,
                                     @NotNull
                                     ExecutableAgentsHelper executableAgentsHelper,
                                     @NotNull
                                     CustomVariableContextRunner customVariableContextRunner,
                                     @NotNull
                                     ExecutionPhaseService executionPhaseService,
                                     @NotNull
                                     XStreamFactory xStreamFactory,
                                     @NotNull
                                     org.springframework.transaction.support.TransactionTemplate transactionTemplate,
                                     @NotNull
                                     LocalResultProcessor resultProcessor)

Method Detail

addToQueue

public void addToQueue(@NotNull
                       CommonContext context)

Description copied from interface: BuildQueueManager

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.

Specified by:

addToQueue in interface BuildQueueManager

removeBuildFromQueue

public void removeBuildFromQueue(@NotNull
                                 ResultKey resultKey)

Description copied from interface: BuildQueueManager

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.

Specified by:

removeBuildFromQueue in interface BuildQueueManager

reorderInQueue

public boolean reorderInQueue(ResultKey resultKey,
                              int index)

Description copied from interface: BuildQueueManager

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.

Specified by:

reorderInQueue in interface BuildQueueManager

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
public BuildQueuePosition getQueuePosition(@NotNull
                                                    ResultKey resultKey)

Description copied from interface: BuildQueueManager

Returns information on position of plan result in the queue.

Specified by:

getQueuePosition in interface BuildQueueManager

Parameters:

resultKey - identifies plan result

Returns:

the [@link BuildQueuePosition} object

invalidateExecutors

public void invalidateExecutors(@NotNull
                                String reason)

Specified by:

invalidateExecutors in interface BuildQueueManager

invalidateExecutors

public void invalidateExecutors(@NotNull
                                Key key)

Specified by:

invalidateExecutors in interface BuildQueueManager

invalidateExecutables

public void invalidateExecutables(@NotNull
                                  BuildAgent buildAgent)

Description copied from interface: BuildQueueManager

Updates all agent-executable mappings for a given agent.

Specified by:

invalidateExecutables in interface BuildQueueManager

getQueuedExecutables

@NotNull
public Iterable<BuildQueueManager.QueuedResultKey> getQueuedExecutables()

Specified by:

getQueuedExecutables in interface BuildQueueManager

Returns:

the currently queued executables.

getImagesForQueuedExecutable

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

Specified by:

getImagesForQueuedExecutable in interface BuildQueueManager

Returns:

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

getExecutorsForQueuedExecutable

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

Specified by:

getExecutorsForQueuedExecutable in interface BuildQueueManager

Returns:

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

peekContext

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

Description copied from interface: BuildQueueManager

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

Specified by:

peekContext in interface BuildQueueManager

Returns:

restoreState

public void restoreState(Set<ResultKey> resultsToRestore)

Description copied from interface: BuildQueueManager

Restore state after server restart.

Specified by:

restoreState in interface BuildQueueManager

Parameters:

resultsToRestore - keys of results that it makes sense to restore

takeBuildContext

@Nullable
public CommonContext takeBuildContext(long agentId)
                                         throws InterruptedException

Description copied from interface: AgentQueueAccessor

Takes a CommonContext from the queue, blocking until one is available.

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.

Specified by:

takeBuildContext in interface AgentQueueAccessor

Parameters:

agentId - the id of the agent that is taking the build context.

Returns:

The CommonContext, null in case of timeout on retrieval.

Throws:

InterruptedException - if the calling Thread is interrupted.

takeContext

@Nullable
public AgentQueueAccessor.QueueAccessResult takeContext(long agentId)
                                                           throws InterruptedException

Description copied from interface: AgentQueueAccessor

Takes a CommonContext from the queue, blocking until one is available.

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.

Specified by:

takeContext in interface AgentQueueAccessor

Parameters:

agentId - the id of the agent that is taking the build context.

Returns:

The AgentQueueAccessor.QueueAccessResult containing: CommonContext on success, error message on error, nulls in case of timeout on retrieval.

Throws:

InterruptedException - if the calling Thread is interrupted.