Package com.atlassian.bamboo.v2.build.queue

Class AgentQueueAccessorImpl

java.lang.Object

com.atlassian.bamboo.v2.build.queue.AgentQueueAccessorImpl

All Implemented Interfaces:

AgentQueueAccessor

public class AgentQueueAccessorImpl
extends Object
implements AgentQueueAccessor

An instance of this class is shared between multiple local agents

Nested Class Summary

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

AgentQueueAccessor.QueueAccessResult

Constructor Summary

Constructors

Constructor	Description
AgentQueueAccessorImpl()

Method Summary

Modifier and Type	Method	Description
@Nullable CommonContext	takeBuildContext(long id)	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.
AgentQueueAccessor.QueueAccessResult	takeContext(long agentId, @Nullable ResultKey resultKey)	If resultKey is not null, takes a specific CommonContext from the queue or nothing if there's no job with specified key in the queue.

Methods inherited from class java.lang.Object

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

Constructor Details

AgentQueueAccessorImpl

public AgentQueueAccessorImpl()

Method Details

takeBuildContext

@Nullable
public @Nullable CommonContext takeBuildContext(long id)
                                         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:

id - 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

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.

takeContext

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

Description copied from interface: AgentQueueAccessor

If resultKey is not null, takes a specific CommonContext from the queue or nothing if there's no job with specified key in the queue. If resultKey is null, behaved identically to AgentQueueAccessor.takeContext(long).

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.

resultKey - of the job that agent expects to receive

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.