Package com.atlassian.bamboo.buildqueue.manager

Interface RemoteAgentManager

All Superinterfaces:

RemotedRemoteAgentManager

All Known Implementing Classes:

RemoteAgentManagerImpl

public interface RemoteAgentManager
extends RemotedRemoteAgentManager

Manages the interactions with remote agents

Method Summary

Modifier and Type	Method	Description
void	addRemoteAgentLogEntry(String logEntry)
void	bootstrapping(String agentHostName)	Notifies the RemoteAgentManager that a remote agent has commenced bootstrapping.
void	bootstrappingElastic(String agentHostName, @Nullable String instanceId)	Notifies the RemoteAgentManager that an elastic agent has commenced bootstrapping.
void	bootstrappingEphemeral(String agentHostName)	Notifies the RemoteAgentManager that an ephemeral agent has commenced bootstrapping.
void	checkOfflineAgents()	Runs a check for offline remote agents.
List<String>	getRemoteAgentLog()
boolean	isRemoteAgentFunctionEnabled()	Checks whether the remote agent functionality is currently enabled.
@NotNull PipelineDefinition	registerAgent(@NotNull PipelineDefinition remoteAgentDefinition)	Initial setup / verification of the agent.
void	setRemoteAgentFunctionEnabled(boolean remoteAgentFunctionEnabled)	Controls whether the remote agent functionality of Bamboo is enabled.
void	start()
void	stopConnectors()
void	stopRemoteAgent(@NotNull BuildAgent agent)
AgentHeartBeatInfo	updateRemoteAgentStatus(@NotNull Long agentId, @Nullable UUID uuid, @NotNull AgentStatus status, @NotNull SystemInfo systemInfo)	Updates the BuildAgent's status representing a remote agent on the local server.

Methods inherited from interface com.atlassian.bamboo.buildqueue.manager.RemotedRemoteAgentManager

registerAgent

Method Detail

registerAgent

@NotNull
@NotNull PipelineDefinition registerAgent(@NotNull
                                          @NotNull PipelineDefinition remoteAgentDefinition)
                                   throws BambooLicenseException

Initial setup / verification of the agent. This method may perform checking of whether the remote agent matches the current version on the server / updates etc

Parameters:

remoteAgentDefinition - - id may be -1 if the build is new

Returns:

RemoteAgentDefinition with the id filled

Throws:

BambooLicenseException

updateRemoteAgentStatus

AgentHeartBeatInfo updateRemoteAgentStatus(@NotNull
                                           @NotNull Long agentId,
                                           @Nullable
                                           @Nullable UUID uuid,
                                           @NotNull
                                           @NotNull AgentStatus status,
                                           @NotNull
                                           @NotNull SystemInfo systemInfo)

Updates the BuildAgent's status representing a remote agent on the local server.

Parameters:

agentId - ID of the agent

uuid - UUID of the agent

status - agent status

systemInfo - agent system info

Returns:

current heart beat info

checkOfflineAgents

void checkOfflineAgents()

Runs a check for offline remote agents.

bootstrapping

void bootstrapping(String agentHostName)

Notifies the RemoteAgentManager that a remote agent has commenced bootstrapping.

Parameters:

agentHostName - The host name or IP address of the host on which the remote agent is running. null if unknown.

bootstrappingEphemeral

void bootstrappingEphemeral(String agentHostName)

Notifies the RemoteAgentManager that an ephemeral agent has commenced bootstrapping.

Parameters:

agentHostName - The host name or IP address of the host on which the remote agent is running. null if unknown.

Since:

9.3

bootstrappingElastic

void bootstrappingElastic(String agentHostName,
                          @Nullable
                          @Nullable String instanceId)

Notifies the RemoteAgentManager that an elastic agent has commenced bootstrapping.

Parameters:

agentHostName - The host name or IP address of the host on which the remote agent is running. null if unknown.

instanceId - the instance the elastic agent is loading on

getRemoteAgentLog

List<String> getRemoteAgentLog()

setRemoteAgentFunctionEnabled

void setRemoteAgentFunctionEnabled(boolean remoteAgentFunctionEnabled)
                            throws Exception

Controls whether the remote agent functionality of Bamboo is enabled.

Parameters:

remoteAgentFunctionEnabled - true if remote agent functionality should be enabled; false otherwise.

Throws:

Exception - on any error

isRemoteAgentFunctionEnabled

boolean isRemoteAgentFunctionEnabled()

Checks whether the remote agent functionality is currently enabled.

Returns:

true, if remote agent functionality is enabled, false otherwise

stopRemoteAgent

void stopRemoteAgent(@NotNull
                     @NotNull BuildAgent agent)

addRemoteAgentLogEntry

void addRemoteAgentLogEntry(String logEntry)

start

void start()
    throws Exception

Throws:

Exception

stopConnectors

void stopConnectors()
             throws Exception

Throws:

Exception