com.atlassian.bamboo.buildqueue.manager
Interface RemoteAgentManager

All Known Implementing Classes:

RemoteAgentManagerImpl

public interface RemoteAgentManager

Manages the interactions with remote agents

Method Summary

void	bootstrapping(java.lang.String agentHostName) Notifies the RemoteAgentManager that a remote agent has commenced bootstrapping.
void	checkOfflineAgents() Runs a check for offline remote agents.
java.util.LinkedList<java.lang.String>	getRemoteAgentLog()
RemoteAgentDefinition	registerAgent(RemoteAgentDefinition remoteAgentDefinition) Initial setup / verification of the agent.
void	setRemoteAgentFunctionEnabled(boolean remoteAgentFunctionEnabled) Controls whether the remote agent functionality of Bamboo is enabled.
boolean	updateRemoteAgentStatus(java.lang.Long agentId, AgentStatus status, SystemInfo systemInfo) Updates the BuildAgentImpl's status representing a remote agent on the local server.

Method Detail

registerAgent

@NotNull
RemoteAgentDefinition registerAgent(@NotNull
                                            RemoteAgentDefinition 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

boolean updateRemoteAgentStatus(@NotNull
                                java.lang.Long agentId,
                                @NotNull
                                AgentStatus status,
                                @NotNull
                                SystemInfo systemInfo)

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

Parameters:

agentId -

status -

systemInfo -

Returns:

checkOfflineAgents

void checkOfflineAgents()

Runs a check for offline remote agents.

bootstrapping

void bootstrapping(java.lang.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.

getRemoteAgentLog

java.util.LinkedList<java.lang.String> getRemoteAgentLog()

setRemoteAgentFunctionEnabled

void setRemoteAgentFunctionEnabled(boolean remoteAgentFunctionEnabled)
                                   throws java.lang.Exception

Controls whether the remote agent functionality of Bamboo is enabled.

Parameters:

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

Throws:

java.lang.Exception