com.atlassian.bamboo.buildqueue.manager

Class AgentManagerImpl

java.lang.Object

com.atlassian.bamboo.buildqueue.manager.AgentManagerImpl

All Implemented Interfaces:

AgentManager, LocalAgentManager

public class AgentManagerImpl
extends Object
implements AgentManager, LocalAgentManager

Field Summary

Fields inherited from interface com.atlassian.bamboo.buildqueue.manager.AgentManager

DEFAULT_AGENT_NAME

Constructor Summary

Constructors

Constructor and Description

AgentManagerImpl(AgentDao agentDao, CapabilitySetManager capabilitySetManager, CapabilityManager capabilityManager, com.atlassian.event.api.EventPublisher eventPublisher, BambooLicenseManager bambooLicenseManager, ElasticInstanceManager elasticInstanceManager, ErrorUpdateHandler errorUpdateHandler, BuildLoggerManager buildLoggerManager, FeatureManager featureManager, DeploymentsInProgressService deploymentsInProgressService, ElasticTunnelDefinitionDao elasticTunnelDefinitionDao)

Method Summary

Modifier and Type	Method and Description
void	abandonBuild(@NotNull 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 numOfAgentsToCreate) 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 definition) 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(@NotNull Collection<Long> agentIds) Returns a Map of PipelineDefinitions keyed by their id
@NotNull Collection<BuildAgent>	getActiveAndEnabledAgents() Returns agents that are enabled and online
@Nullable BuildAgent	getAgent(long agentId)
long	getAgentCount(Class<? extends PipelineDefinition> agentDefinitionClass) Retrieves the amount of agents of given type stored in the database
@Nullable PipelineDefinition	getAgentDefinition(@NotNull Long agentId)
@Nullable PipelineDefinition	getAgentDefinitionByName(@NotNull String name) Retrieve a pipelineDefinition by name.
@NotNull List<PipelineDefinition>	getAgentDefinitionsWithNameLike(@NotNull String likeName) Return a list of agents whose name is like the provided string.
@NotNull List<BuildAgent>	getAllAgents()
@NotNull List<ElasticAgentDefinition>	getAllElasticAgentDefinitions(@NotNull Collection<String> instanceIds) Retrieve elastic agent definitions from db.
@NotNull List<ElasticAgentDefinition>	getAllElasticAgentDefinitions(int firstResult, int maxResults) Retrieve most recently terminated elastic agent definitions from db, ordered by termination time, descending.
@NotNull List<LocalBuildAgent>	getAllLocalAgents() Returns all LocalBuildAgent objects
@NotNull List<BuildAgent>	getAllNonElasticAgents()
List<PipelineDefinition>	getAllPersistedAgentDefinitions() Retrieves a list of all agent definitions stored in the database.
@NotNull List<BuildAgent>	getAllRemoteAgents() Gets all remote agents in the system.
@NotNull List<BuildAgent>	getAllRemoteAgents(boolean onlineOnly) Get remote agents.
@NotNull Collection<BuildAgent>	getBusyBuildAgents() Gets a collection agents that are currently building or cancelling a build
@NotNull Collection<BuildAgent>	getElasticActiveAndEnabledAgents() Returns elastic agents that are enabled and online
@NotNull Collection<LocalBuildAgent>	getLocalActiveAndEnabledAgents() Returns local agents that are enabled and online
LocalBuildAgent	getLocalAgent(long pipelineId) Returns the pipeline that matches the passed id
@NotNull List<BuildAgent>	getOnlineElasticAgents() Retrieve all online elastic build agents.
@NotNull 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(@NotNull 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(@NotNull PipelineDefinition pipelineDefinition) Stores a pipeline PipelineDefinition of any type (elastic, local, remote) AgentConfigurationUpdateEvent is fired after the pipeline is saved
void	saveAnyPipeline(@NotNull PipelineDefinition pipelineDefinition, @Nullable AgentConfigurationUpdatedEventFactory eventFactory) Stores a pipeline PipelineDefinition of any type (elastic, local, remote)
void	saveElasticPipeline(@NotNull ElasticAgentDefinition elasticDefinition) Stores the elastic PipelineDefinition
void	savePipeline(@NotNull PipelineDefinition pipelineDefinition) Stores the PipelineDefinition.
void	savePipeline(@NotNull PipelineDefinition pipelineDefinition, @Nullable AgentConfigurationUpdatedEventFactory eventFactory) Stores the PipelineDefinition.
void	saveReturningElasticPipeline(@NotNull ElasticAgentDefinition elasticDefinition) Stores the elastic PipelineDefinition of a returning elastic agent.
void	startLocalAgents() Starts all current LocalBuildAgent objects
void	stopAgent(@NotNull 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentManagerImpl

public AgentManagerImpl(AgentDao agentDao,
                        CapabilitySetManager capabilitySetManager,
                        CapabilityManager capabilityManager,
                        com.atlassian.event.api.EventPublisher eventPublisher,
                        BambooLicenseManager bambooLicenseManager,
                        ElasticInstanceManager elasticInstanceManager,
                        ErrorUpdateHandler errorUpdateHandler,
                        BuildLoggerManager buildLoggerManager,
                        FeatureManager featureManager,
                        DeploymentsInProgressService deploymentsInProgressService,
                        ElasticTunnelDefinitionDao elasticTunnelDefinitionDao)

Method Detail

createDefaultAgent

public void createDefaultAgent()

Description copied from interface: AgentManager

sets up a default local agent if no local agent exists

Specified by:

createDefaultAgent in interface AgentManager

initAgents

public void initAgents()

Description copied from interface: AgentManager

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

Specified by:

initAgents in interface AgentManager

startLocalAgents

public void startLocalAgents()

Description copied from interface: AgentManager

Starts all current LocalBuildAgent objects

Specified by:

startLocalAgents in interface AgentManager

stopLocalAgents

public void stopLocalAgents()

Description copied from interface: AgentManager

Stops all LocalBuildAgent

Specified by:

stopLocalAgents in interface AgentManager

getAllLocalAgents

@NotNull
public @NotNull List<LocalBuildAgent> getAllLocalAgents()

Description copied from interface: AgentManager

Returns all LocalBuildAgent objects

Specified by:

getAllLocalAgents in interface AgentManager

Returns:

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

getOnlineElasticAgents

@NotNull
public @NotNull List<BuildAgent> getOnlineElasticAgents()

Description copied from interface: AgentManager

Retrieve all online elastic build agents.

Specified by:

getOnlineElasticAgents in interface AgentManager

Returns:

getAllElasticAgentDefinitions

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

Description copied from interface: AgentManager

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

Specified by:

getAllElasticAgentDefinitions in interface AgentManager

Returns:

list of ElasticAgents

getAgentCount

public long getAgentCount(Class<? extends PipelineDefinition> agentDefinitionClass)

Description copied from interface: AgentManager

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

Specified by:

getAgentCount in interface AgentManager

Parameters:

agentDefinitionClass - agent type

Returns:

amount of agents

getAllElasticAgentDefinitions

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

Description copied from interface: AgentManager

Retrieve elastic agent definitions from db.

Specified by:

getAllElasticAgentDefinitions in interface AgentManager

Parameters:

instanceIds - the instances ids on which the agents were running

Returns:

list of ElasticAgents

getAllRemoteAgents

@NotNull
public @NotNull List<BuildAgent> getAllRemoteAgents(boolean onlineOnly)

Description copied from interface: AgentManager

Get remote agents.

Specified by:

getAllRemoteAgents in interface AgentManager

Parameters:

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

Returns:

getAllRemoteAgents

@NotNull
public @NotNull List<BuildAgent> getAllRemoteAgents()

Description copied from interface: AgentManager

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

Specified by:

getAllRemoteAgents in interface AgentManager

Returns:

all remote agents.

getAllAgents

@NotNull
public @NotNull List<BuildAgent> getAllAgents()

Specified by:

getAllAgents in interface AgentManager

getAllNonElasticAgents

@NotNull
public @NotNull List<BuildAgent> getAllNonElasticAgents()

Specified by:

getAllNonElasticAgents in interface AgentManager

getBusyBuildAgents

@NotNull
public @NotNull Collection<BuildAgent> getBusyBuildAgents()

Description copied from interface: AgentManager

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

Specified by:

getBusyBuildAgents in interface AgentManager

Returns:

Collection of BuildAgent

getActiveAndEnabledAgents

@NotNull
public @NotNull Collection<BuildAgent> getActiveAndEnabledAgents()

Description copied from interface: AgentManager

Returns agents that are enabled and online

Specified by:

getActiveAndEnabledAgents in interface AgentManager

Returns:

Collection of BuildAgent

getRemoteActiveAndEnabledAgents

@NotNull
public @NotNull Collection<BuildAgent> getRemoteActiveAndEnabledAgents()

Description copied from interface: AgentManager

Returns remote agents that are enabled and online

Specified by:

getRemoteActiveAndEnabledAgents in interface AgentManager

Returns:

Collection of BuildAgent

getElasticActiveAndEnabledAgents

@NotNull
public @NotNull Collection<BuildAgent> getElasticActiveAndEnabledAgents()

Description copied from interface: AgentManager

Returns elastic agents that are enabled and online

Specified by:

getElasticActiveAndEnabledAgents in interface AgentManager

Returns:

Collection of BuildAgent

getLocalActiveAndEnabledAgents

@NotNull
public @NotNull Collection<LocalBuildAgent> getLocalActiveAndEnabledAgents()

Description copied from interface: AgentManager

Returns local agents that are enabled and online

Specified by:

getLocalActiveAndEnabledAgents in interface AgentManager

Returns:

Collection of LocalBuildAgent

createLocalAgent

public void createLocalAgent(LocalAgentDefinition definition)
                      throws BambooLicenseException

Description copied from interface: AgentManager

Create a new local agent.

Specified by:

createLocalAgent in interface AgentManager

Throws:

BambooLicenseException

savePipeline

public void savePipeline(@NotNull
                         @NotNull PipelineDefinition pipelineDefinition)

Description copied from interface: AgentManager

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

Specified by:

savePipeline in interface AgentManager

Parameters:

pipelineDefinition - - Must not be null

savePipeline

public void savePipeline(@NotNull
                         @NotNull PipelineDefinition pipelineDefinition,
                         @Nullable
                         @Nullable AgentConfigurationUpdatedEventFactory eventFactory)

Description copied from interface: AgentManager

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

Specified by:

savePipeline in interface AgentManager

Parameters:

pipelineDefinition - - Must not be null

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

saveElasticPipeline

public void saveElasticPipeline(@NotNull
                                @NotNull ElasticAgentDefinition elasticDefinition)

Description copied from interface: AgentManager

Stores the elastic PipelineDefinition

Specified by:

saveElasticPipeline in interface AgentManager

Parameters:

elasticDefinition - - Must not be null

saveReturningElasticPipeline

public void saveReturningElasticPipeline(@NotNull
                                         @NotNull ElasticAgentDefinition elasticDefinition)

Description copied from interface: AgentManager

Stores the elastic PipelineDefinition of a returning elastic agent.

Specified by:

saveReturningElasticPipeline in interface AgentManager

Parameters:

elasticDefinition - returning elastic agent definition

getAllPersistedAgentDefinitions

public List<PipelineDefinition> getAllPersistedAgentDefinitions()

Description copied from interface: AgentManager

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

Specified by:

getAllPersistedAgentDefinitions in interface AgentManager

abandonBuild

public void abandonBuild(@NotNull
                         @NotNull BuildAgent remoteAgent,
                         boolean agentStartingUp)

Specified by:

abandonBuild in interface AgentManager

onAgentReturning

public void onAgentReturning(@NotNull
                             @NotNull BuildAgent agent)

Description copied from interface: AgentManager

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.

Specified by:

onAgentReturning in interface AgentManager

Parameters:

agent - to be stopped

stopAgent

public void stopAgent(@NotNull
                      @NotNull BuildAgent agent)

Description copied from interface: AgentManager

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

Specified by:

stopAgent in interface AgentManager

Parameters:

agent - to be stopped

getLocalAgent

public LocalBuildAgent getLocalAgent(long pipelineId)

Description copied from interface: AgentManager

Returns the pipeline that matches the passed id

Specified by:

getLocalAgent in interface AgentManager

Returns:

Matching LocalBuildAgent object. Null if pipeline does not exist

getAgent

@Nullable
public @Nullable BuildAgent getAgent(long agentId)

Specified by:

getAgent in interface AgentManager

getAgentDefinition

@Nullable
public @Nullable PipelineDefinition getAgentDefinition(@NotNull
                                                                 @NotNull Long agentId)

Specified by:

getAgentDefinition in interface AgentManager

findAllAgentsForAgentIds

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

Description copied from interface: AgentManager

Returns a Map of PipelineDefinitions keyed by their id

Specified by:

findAllAgentsForAgentIds in interface AgentManager

Returns:

agentMap

getAgentDefinitionByName

@Nullable
public @Nullable PipelineDefinition getAgentDefinitionByName(@NotNull
                                                                       @NotNull String name)

Description copied from interface: AgentManager

Retrieve a pipelineDefinition by name. Names should be unique.

Specified by:

getAgentDefinitionByName in interface AgentManager

Parameters:

name - of the agent to find

Returns:

the agent that has the given name.

getAgentDefinitionsWithNameLike

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

Description copied from interface: AgentManager

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

Specified by:

getAgentDefinitionsWithNameLike in interface AgentManager

Parameters:

likeName - the string to match

Returns:

List of Pipeline Definitions

saveAnyPipeline

public void saveAnyPipeline(@NotNull
                            @NotNull PipelineDefinition pipelineDefinition)

Description copied from interface: AgentManager

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

Specified by:

saveAnyPipeline in interface AgentManager

Parameters:

pipelineDefinition - - Must not be null

saveAnyPipeline

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

Description copied from interface: AgentManager

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

Specified by:

saveAnyPipeline in interface AgentManager

Parameters:

pipelineDefinition - Must not be null

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

disableAllAgents

public void disableAllAgents()

Description copied from interface: AgentManager

Disable all pipelines

Specified by:

disableAllAgents in interface AgentManager

enableAllAgents

public void enableAllAgents()

Description copied from interface: AgentManager

Enable all pipelines

Specified by:

enableAllAgents in interface AgentManager

checkPipelinesAreDisabled

public boolean checkPipelinesAreDisabled()

Specified by:

checkPipelinesAreDisabled in interface AgentManager

Returns:

whether or not all pipelines are disabled

executeIfIdle

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

Description copied from interface: AgentManager

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

Specified by:

executeIfIdle in interface AgentManager

Parameters:

callable - the Callable to be executed

Returns:

the result of callable

Throws:

BambooBusyException - if builds are in progress

Exception - if thrown by callable

removeAgent

public void removeAgent(long agentId)
                 throws TimeoutException

Description copied from interface: AgentManager

Removes the passed agent

Specified by:

removeAgent in interface AgentManager

Throws:

TimeoutException

allowNewRemoteAgent

public boolean allowNewRemoteAgent()

Description copied from interface: AgentManager

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.

Specified by:

allowNewRemoteAgent in interface AgentManager

Returns:

true if a new agent is allowed, otherise false

allowNewRemoteAgents

public boolean allowNewRemoteAgents(int numOfAgentsToCreate)

Description copied from interface: AgentManager

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.

Specified by:

allowNewRemoteAgents in interface AgentManager

Returns:

true if a specified number agents is allowed, otherise false

allowNewElasticAgent

public boolean allowNewElasticAgent()

Description copied from interface: AgentManager

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

Specified by:

allowNewElasticAgent in interface AgentManager

Returns:

true if a new agent is allowed, otherise false

allowNewElasticAgents

public boolean allowNewElasticAgents(int numOfAgentsToCreate)

Description copied from interface: AgentManager

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

Specified by:

allowNewElasticAgents in interface AgentManager

Returns:

true if a specified number agents is allowed, otherise false

allowNewLocalAgent

public boolean allowNewLocalAgent()

Description copied from interface: AgentManager

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

Specified by:

allowNewLocalAgent in interface AgentManager

Returns:

true if a new local agent is allowed, otherwise false

updateAgentStatusIfResultReturnPossibleAfterServerRestart

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

Description copied from interface: AgentManager

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.

Specified by:

updateAgentStatusIfResultReturnPossibleAfterServerRestart in interface AgentManager

Returns:

true iff agents is capable of surviving a server restart.