com.atlassian.bamboo.v2.build.queue.queues

Class AbstractQueueOfExecutables

java.lang.Object

com.atlassian.bamboo.v2.build.queue.queues.AbstractQueueOfExecutables

All Implemented Interfaces:

QueueOfExecutables

Direct Known Subclasses:

OffloadingQueueOfExecutables, SimpleQueueOfExecutables

public abstract class AbstractQueueOfExecutables
extends Object
implements QueueOfExecutables

Nested Class Summary

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

QueueOfExecutables.ExecutableData

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractQueueOfExecutables(ExecutorCalculator executorCalculator, CommonContextMap map)

Method Summary

Modifier and Type	Method and Description
boolean	enqueue(CommonContext context, MinimalRequirementSet requirements) Adds a new executable to store.
com.google.common.collect.ImmutableList<QueueOfExecutables.ExecutableData>	executablesForAgent(long agentId) Returns executables available for an agent.
CommonContext	get(ResultKey resultKey) Retrieves an executable with given key from storage.
Set<Long>	getExecutorsForExecutable(ResultKey resultKey) Returns the executors currently considered to be eligible for building resultKey.
Collection<ElasticImageConfiguration>	getImagesForExecutable(ResultKey resultKey) Returns the images currently considered to be eligible for building resultKey.
CommonContext	inflight(ResultKey resultKey) Called when a given executable is en route to agent.
void	recalculateExecutables(BuildAgent agent) Updates all agent-executable mappings for a given agent.
void	recalculateExecutors() Recalculates executors for all executables - until then, any information about executor-executable mapping should be considered to be invalid.
void	recalculateExecutors(Set<Key> keys) Recalculates executors for a given plan - until then, any information about executor-executable mapping for this plan should be considered to be invalid.
CommonContext	remove(ResultKey resultKey) Called when an executable should be removed from the queue.
int	size() Returns the amount of executables in queue (not counting executables in flight)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractQueueOfExecutables

protected AbstractQueueOfExecutables(ExecutorCalculator executorCalculator,
                                     CommonContextMap map)

Method Detail

inflight

@Nullable
public CommonContext inflight(@NotNull
                                        ResultKey resultKey)

Description copied from interface: QueueOfExecutables

Called when a given executable is en route to agent. May be implemented as a simple remove(). Executables in flight should be treated as removed, but may be put back into a queue if an agent fails to acknolwedge that it received the executable.

Specified by:

inflight in interface QueueOfExecutables

Returns:

the removed context

remove

@Nullable
public CommonContext remove(@NotNull
                                      ResultKey resultKey)

Description copied from interface: QueueOfExecutables

Called when an executable should be removed from the queue. will not be called concurrently

Specified by:

remove in interface QueueOfExecutables

Returns:

the removed context

enqueue

public boolean enqueue(@NotNull
                       CommonContext context,
                       @Nullable
                       MinimalRequirementSet requirements)

Description copied from interface: QueueOfExecutables

Adds a new executable to store. Will not be called concurrently. Returns false if requirements could not be retrieved for a build and were not provided in the call (assumption: the reason is that the build got deleted).

Specified by:

enqueue in interface QueueOfExecutables

executablesForAgent

@NotNull
public com.google.common.collect.ImmutableList<QueueOfExecutables.ExecutableData> executablesForAgent(long agentId)

Description copied from interface: QueueOfExecutables

Returns executables available for an agent.

Specified by:

executablesForAgent in interface QueueOfExecutables

recalculateExecutables

public void recalculateExecutables(BuildAgent agent)

Description copied from interface: QueueOfExecutables

Updates all agent-executable mappings for a given agent.

Specified by:

recalculateExecutables in interface QueueOfExecutables

recalculateExecutors

public void recalculateExecutors()

Description copied from interface: QueueOfExecutables

Recalculates executors for all executables - until then, any information about executor-executable mapping should be considered to be invalid.

Specified by:

recalculateExecutors in interface QueueOfExecutables

size

public int size()

Description copied from interface: QueueOfExecutables

Returns the amount of executables in queue (not counting executables in flight)

Specified by:

size in interface QueueOfExecutables

getImagesForExecutable

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

Description copied from interface: QueueOfExecutables

Returns the images currently considered to be eligible for building resultKey.

Specified by:

getImagesForExecutable in interface QueueOfExecutables

getExecutorsForExecutable

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

Description copied from interface: QueueOfExecutables

Returns the executors currently considered to be eligible for building resultKey.

Specified by:

getExecutorsForExecutable in interface QueueOfExecutables

recalculateExecutors

public void recalculateExecutors(@NotNull
                                 Set<Key> keys)

Description copied from interface: QueueOfExecutables

Recalculates executors for a given plan - until then, any information about executor-executable mapping for this plan should be considered to be invalid.

Specified by:

recalculateExecutors in interface QueueOfExecutables

Parameters:

keys - the keys to invalidate

get

@Nullable
public CommonContext get(@NotNull
                                   ResultKey resultKey)

Description copied from interface: QueueOfExecutables

Retrieves an executable with given key from storage.

Specified by:

get in interface QueueOfExecutables