com.atlassian.bamboo.buildqueue.manager

Interface AgentManager

All Known Subinterfaces:

LocalAgentManager

All Known Implementing Classes:

AgentManagerImpl

public interface AgentManager

Manages the LocalBuildAgent and PipelineDefinition funnily enough. The class is fully synchronized.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_AGENT_NAME

Method Summary

Modifier and Type	Method and Description
void	abandonBuild(BuildAgent remoteAgent, boolean agentStartingUp)
boolean	allowNewElasticAgent() Allow an elastic agent to register and come online? Based on licensing restrictions.
boolean	allowNewElasticAgents(int numOfAgentsToCreate) Allow a specified number of elastic agents to register and come online? Based on licensing restrictions.
boolean	allowNewLocalAgent() Allow a local agent to come online? Based on licensing restrictions.
boolean	allowNewRemoteAgent() Allow a remote agent to register and come online? Based on licensing restrictions.
boolean	allowNewRemoteAgents(int numAgentsToCreate) Allow a specified number of remote agents to register and come online? Based on licensing restrictions.
boolean	checkPipelinesAreDisabled()
void	createDefaultAgent() sets up a default local agent if no local agent exists
void	createLocalAgent(LocalAgentDefinition pipelineDefinition) Create a new local agent.
void	disableAllAgents() Disable all pipelines
void	enableAllAgents() Enable all pipelines
<T> T	executeIfIdle(Callable<T> callable) Executes a given Callable only if no builds are in progress.
Map<Long,PipelineDefinition>	findAllAgentsForAgentIds(Collection<Long> agentIds) Returns a Map of PipelineDefinitions keyed by their id
Collection<BuildAgent>	getActiveAndEnabledAgents() Returns agents that are enabled and online
BuildAgent	getAgent(long agentId)
long	getAgentCount(Class<? extends PipelineDefinition> agentDefinitionClass) Retrieves the amount of agents of given type stored in the database
PipelineDefinition	getAgentDefinition(Long agentId)
PipelineDefinition	getAgentDefinitionByName(String name) Retrieve a pipelineDefinition by name.
List<PipelineDefinition>	getAgentDefinitionsWithNameLike(String likeName) Return a list of agents whose name is like the provided string.
List<BuildAgent>	getAllAgents()
List<ElasticAgentDefinition>	getAllElasticAgentDefinitions(Collection<String> instanceIds) Retrieve elastic agent definitions from db.
List<ElasticAgentDefinition>	getAllElasticAgentDefinitions(int firstResult, int maxResults) Retrieve most recently terminated elastic agent definitions from db, ordered by termination time, descending.
List<LocalBuildAgent>	getAllLocalAgents() Returns all LocalBuildAgent objects
List<BuildAgent>	getAllNonElasticAgents()
List<PipelineDefinition>	getAllPersistedAgentDefinitions() Retrieves a list of all agent definitions stored in the database.
List<BuildAgent>	getAllRemoteAgents() Gets all remote agents in the system.
List<BuildAgent>	getAllRemoteAgents(boolean onlineOnly) Get remote agents.
Collection<BuildAgent>	getBusyBuildAgents() Gets a collection agents that are currently building or cancelling a build
Collection<BuildAgent>	getElasticActiveAndEnabledAgents() Returns elastic agents that are enabled and online
Collection<LocalBuildAgent>	getLocalActiveAndEnabledAgents() Returns local agents that are enabled and online
LocalBuildAgent	getLocalAgent(long pipelineId) Returns the pipeline that matches the passed id
List<BuildAgent>	getOnlineElasticAgents() Retrieve all online elastic build agents.
Collection<BuildAgent>	getRemoteActiveAndEnabledAgents() Returns remote agents that are enabled and online
void	initAgents() Inits the local agents Must be ran before any other methods.
void	onAgentReturning(BuildAgent agent) Performs any other operations required when an agent goes offline, such as updating the status and shutdown time.
void	removeAgent(long agentId) Removes the passed agent
void	saveAnyPipeline(PipelineDefinition pipelineDefinition) Stores a pipeline PipelineDefinition of any type (elastic, local, remote) AgentConfigurationUpdateEvent is fired after the pipeline is saved
void	saveAnyPipeline(PipelineDefinition pipelineDefinition, AgentConfigurationUpdatedEventFactory eventFactory) Stores a pipeline PipelineDefinition of any type (elastic, local, remote)
void	saveElasticPipeline(ElasticAgentDefinition pipelineDefinition) Stores the elastic PipelineDefinition
void	savePipeline(PipelineDefinition pipelineDefinition) Stores the PipelineDefinition.
void	savePipeline(PipelineDefinition pipelineDefinition, AgentConfigurationUpdatedEventFactory eventFactory) Stores the PipelineDefinition.
void	saveReturningElasticPipeline(ElasticAgentDefinition elasticDefinition) Stores the elastic PipelineDefinition of a returning elastic agent.
void	startLocalAgents() Starts all current LocalBuildAgent objects
void	stopAgent(BuildAgent agent) Performs any other operations required when an agent goes offline, such as updating the status and shutdown time.
void	stopLocalAgents() Stops all LocalBuildAgent
boolean	updateAgentStatusIfResultReturnPossibleAfterServerRestart(long agentId, ResultKey resultKey, String displayName, long deploymentResultId) Checks if agent is capable of 'surviving' a server restart, i.e.

Field Detail

DEFAULT_AGENT_NAME

static final String DEFAULT_AGENT_NAME

See Also:

Constant Field Values

Method Detail

createDefaultAgent

void createDefaultAgent()

sets up a default local agent if no local agent exists

initAgents

void initAgents()

Inits the local agents Must be ran before any other methods.

startLocalAgents

void startLocalAgents()

Starts all current LocalBuildAgent objects

stopLocalAgents

void stopLocalAgents()
              throws InterruptedException

Stops all LocalBuildAgent

Throws:

InterruptedException

getAllLocalAgents

@NotNull
List<LocalBuildAgent> getAllLocalAgents()

Returns all LocalBuildAgent objects

Returns:

A copied collection of LocalBuildAgent objects, or an empty collection if none exists.

getAllRemoteAgents

@NotNull
List<BuildAgent> getAllRemoteAgents()

Gets all remote agents in the system. They can be offline.

Returns:

all remote agents.

getAllRemoteAgents

@NotNull
List<BuildAgent> getAllRemoteAgents(boolean onlineOnly)

Get remote agents.

Parameters:

onlineOnly - - only return those agents which are online currently.

Returns:

getAllElasticAgentDefinitions

@NotNull
List<ElasticAgentDefinition> getAllElasticAgentDefinitions(int firstResult,
                                                                    int maxResults)

Retrieve most recently terminated elastic agent definitions from db, ordered by termination time, descending.

Returns:

list of ElasticAgents

getAgentCount

long getAgentCount(Class<? extends PipelineDefinition> agentDefinitionClass)

Retrieves the amount of agents of given type stored in the database

Parameters:

agentDefinitionClass - agent type

Returns:

amount of agents

getAllElasticAgentDefinitions

@NotNull
List<ElasticAgentDefinition> getAllElasticAgentDefinitions(@NotNull
                                                                    Collection<String> instanceIds)

Retrieve elastic agent definitions from db.

Parameters:

instanceIds - the instances ids on which the agents were running

Returns:

list of ElasticAgents

getOnlineElasticAgents

@NotNull
List<BuildAgent> getOnlineElasticAgents()

Retrieve all online elastic build agents.

Returns:

getAllAgents

@NotNull
List<BuildAgent> getAllAgents()

getAllNonElasticAgents

@NotNull
List<BuildAgent> getAllNonElasticAgents()

getBusyBuildAgents

@NotNull
Collection<BuildAgent> getBusyBuildAgents()

Gets a collection agents that are currently building or cancelling a build

Returns:

Collection of BuildAgent

getActiveAndEnabledAgents

@NotNull
Collection<BuildAgent> getActiveAndEnabledAgents()

Returns agents that are enabled and online

Returns:

Collection of BuildAgent

getRemoteActiveAndEnabledAgents

@NotNull
Collection<BuildAgent> getRemoteActiveAndEnabledAgents()

Returns remote agents that are enabled and online

Returns:

Collection of BuildAgent

getElasticActiveAndEnabledAgents

@NotNull
Collection<BuildAgent> getElasticActiveAndEnabledAgents()

Returns elastic agents that are enabled and online

Returns:

Collection of BuildAgent

getLocalActiveAndEnabledAgents

@NotNull
Collection<LocalBuildAgent> getLocalActiveAndEnabledAgents()

Returns local agents that are enabled and online

Returns:

Collection of LocalBuildAgent

savePipeline

void savePipeline(PipelineDefinition pipelineDefinition)

Stores the PipelineDefinition. Updates any caches so calls to getLocalAgent(long) will return the LocalBuildAgent returns with the new definition

Parameters:

pipelineDefinition - - Must not be null

savePipeline

void savePipeline(PipelineDefinition pipelineDefinition,
                  @Nullable
                  AgentConfigurationUpdatedEventFactory eventFactory)

Stores the PipelineDefinition. Updates any caches so calls to getLocalAgent(long) will return the LocalBuildAgent returns with the new definition

Parameters:

pipelineDefinition - - Must not be null

eventFactory - event factory used to create event sent after the pipeline is saved

saveElasticPipeline

void saveElasticPipeline(@NotNull
                         ElasticAgentDefinition pipelineDefinition)

Stores the elastic PipelineDefinition

Parameters:

pipelineDefinition - - Must not be null

saveReturningElasticPipeline

void saveReturningElasticPipeline(@NotNull
                                  ElasticAgentDefinition elasticDefinition)

Stores the elastic PipelineDefinition of a returning elastic agent.

Parameters:

elasticDefinition - returning elastic agent definition

getLocalAgent

LocalBuildAgent getLocalAgent(long pipelineId)

Returns the pipeline that matches the passed id

Parameters:

pipelineId -

Returns:

Matching LocalBuildAgent object. Null if pipeline does not exist

getAgent

@Nullable
BuildAgent getAgent(long agentId)

getAgentDefinition

@Nullable
PipelineDefinition getAgentDefinition(@NotNull
                                                Long agentId)

findAllAgentsForAgentIds

Map<Long,PipelineDefinition> findAllAgentsForAgentIds(@NotNull
                                                      Collection<Long> agentIds)

Returns a Map of PipelineDefinitions keyed by their id

Parameters:

agentIds -

Returns:

agentMap

disableAllAgents

void disableAllAgents()

Disable all pipelines

enableAllAgents

void enableAllAgents()

Enable all pipelines

checkPipelinesAreDisabled

boolean checkPipelinesAreDisabled()

Returns:

whether or not all pipelines are disabled

executeIfIdle

<T> T executeIfIdle(Callable<T> callable)
             throws Exception

Executes a given Callable only if no builds are in progress. Builds are prevented from starting while the Callable executes.

Parameters:

callable - the Callable to be executed

Returns:

the result of callable

Throws:

BambooBusyException - if builds are in progress

Exception - if thrown by callable

createLocalAgent

void createLocalAgent(LocalAgentDefinition pipelineDefinition)
               throws BambooLicenseException

Create a new local agent.

Parameters:

pipelineDefinition -

Throws:

BambooLicenseException

removeAgent

void removeAgent(long agentId)
          throws TimeoutException

Removes the passed agent

Parameters:

agentId -

Throws:

TimeoutException

allowNewRemoteAgent

boolean allowNewRemoteAgent()

Allow a remote agent to register and come online? Based on licensing restrictions. The method takes into consideration the number of agents "reserved" for pending elastic instances.

Returns:

true if a new agent is allowed, otherise false

allowNewRemoteAgents

boolean allowNewRemoteAgents(int numAgentsToCreate)

Allow a specified number of remote agents to register and come online? Based on licensing restrictions. The method takes into consideration the number of agents "reserved" for pending elastic instances.

Returns:

true if a specified number agents is allowed, otherise false

allowNewElasticAgent

boolean allowNewElasticAgent()

Allow an elastic agent to register and come online? Based on licensing restrictions.

Returns:

true if a new agent is allowed, otherise false

allowNewElasticAgents

boolean allowNewElasticAgents(int numOfAgentsToCreate)

Allow a specified number of elastic agents to register and come online? Based on licensing restrictions.

Returns:

true if a specified number agents is allowed, otherise false

allowNewLocalAgent

boolean allowNewLocalAgent()

Allow a local agent to come online? Based on licensing restrictions.

Returns:

true if a new local agent is allowed, otherwise false

stopAgent

void stopAgent(@NotNull
               BuildAgent agent)

Performs any other operations required when an agent goes offline, such as updating the status and shutdown time.

Parameters:

agent - to be stopped

onAgentReturning

void onAgentReturning(@NotNull
                      BuildAgent agent)

Performs any other operations required when an agent goes offline, such as updating the status and shutdown time. Called when agent re-registered without being marked as offline.

Parameters:

agent - to be stopped

getAllPersistedAgentDefinitions

List<PipelineDefinition> getAllPersistedAgentDefinitions()

Retrieves a list of all agent definitions stored in the database.

abandonBuild

void abandonBuild(@NotNull
                  BuildAgent remoteAgent,
                  boolean agentStartingUp)

getAgentDefinitionByName

@Nullable
PipelineDefinition getAgentDefinitionByName(@NotNull
                                                      String name)

Retrieve a pipelineDefinition by name. Names should be unique.

Parameters:

name - of the agent to find

Returns:

the agent that has the given name.

getAgentDefinitionsWithNameLike

@NotNull
List<PipelineDefinition> getAgentDefinitionsWithNameLike(@NotNull
                                                                  String likeName)

Return a list of agents whose name is like the provided string. Uses hibernate's "like" so % to mark wild card.

Parameters:

likeName - the string to match

Returns:

List of Pipeline Definitions

saveAnyPipeline

void saveAnyPipeline(@NotNull
                     PipelineDefinition pipelineDefinition)

Stores a pipeline PipelineDefinition of any type (elastic, local, remote) AgentConfigurationUpdateEvent is fired after the pipeline is saved

Parameters:

pipelineDefinition - - Must not be null

saveAnyPipeline

void saveAnyPipeline(@NotNull
                     PipelineDefinition pipelineDefinition,
                     @Nullable
                     AgentConfigurationUpdatedEventFactory eventFactory)

Stores a pipeline PipelineDefinition of any type (elastic, local, remote)

Parameters:

pipelineDefinition - Must not be null

eventFactory - event factory used to create event sent after the pipeline is saved

updateAgentStatusIfResultReturnPossibleAfterServerRestart

boolean updateAgentStatusIfResultReturnPossibleAfterServerRestart(long agentId,
                                                                  ResultKey resultKey,
                                                                  String displayName,
                                                                  long deploymentResultId)

Checks if agent is capable of 'surviving' a server restart, i.e. if agent exists and is configured to reconnect after server restart, allowing it to return build result produced while the server was down. Sets agent status to 'building' if it is so.

Returns:

true iff agents is capable of surviving a server restart.

Since:

5.8