com.atlassian.bamboo.v2.build.queue

Interface QueueOfExecutables

All Known Implementing Classes:

AbstractQueueOfExecutables, OffloadingQueueOfExecutables, SimpleQueueOfExecutables

@ThreadSafe
public interface QueueOfExecutables

Provides an unordered store for executables.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	QueueOfExecutables.ExecutableData Stores basic data about an executable.

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)

Method Detail

get

@Nullable
CommonContext get(@NotNull
                            ResultKey resultKey)

Retrieves an executable with given key from storage.

enqueue

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

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).

inflight

@Nullable
CommonContext inflight(@NotNull
                                 ResultKey resultKey)

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.

Returns:

the removed context

remove

@Nullable
CommonContext remove(@NotNull
                               ResultKey resultKey)

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

Returns:

the removed context

executablesForAgent

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

Returns executables available for an agent.

recalculateExecutables

void recalculateExecutables(BuildAgent agent)

Updates all agent-executable mappings for a given agent.

recalculateExecutors

void recalculateExecutors(@NotNull
                          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.

Parameters:

keys - the keys to invalidate

recalculateExecutors

void recalculateExecutors()

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

size

int size()

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

getImagesForExecutable

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

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

getExecutorsForExecutable

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

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