com.atlassian.bamboo.v2.build.agent

Class DefaultBuildAgent

java.lang.Object

com.atlassian.bamboo.v2.build.agent.DefaultBuildAgent

All Implemented Interfaces:

ExecutableBuildAgent

Direct Known Subclasses:

RemoteBuildAgent

@ThreadSafe
public class DefaultBuildAgent
extends Object
implements ExecutableBuildAgent

Constructor Summary

Constructors

Constructor and Description
DefaultBuildAgent(BuildAgentController buildAgentController, BuildLoggerManager buildLoggerManager, long agentId, String agentName, String agentDescription) Deprecated. since 5.10, use DefaultBuildAgent(long, String, String)
DefaultBuildAgent(long agentId, String agentName, String agentDescription)

Method Summary

Modifier and Type	Method and Description
void	build(ReadOnlyCapabilitySet agentCapabilities, DockerContainerController dockerContainerController) Executes the passed CommonContext
boolean	cancelBuild(String buildResultKey) Cancels the passed buildResultKey if it matches
int	compareTo(BuildAgent o)
void	disable()
void	enable()
boolean	equals(Object o)
<V> V	executeWithCurrentContext(Callable<V> callable) Execute with guarantee that context will not be switched during execution.
AgentStatus	getAgentStatus()
CommonContext	getBuilding() Gets the BuildContext related to the build that is building on the agent.
String	getDescription() Agent description
long	getId() Agent id
String	getName() Agent name
int	hashCode()
int	incrementError() Tells the agent that an unhandled error has occurred.
boolean	isActive()
boolean	isCancelling()
boolean	isEnabled()
boolean	isStopping()
protected void	onBetweenBuilds()
void	onBuildProcessingFinished() This method is called when the build process is completed and the result processing has finished.
void	onContextReceived() This method is called when the agent has just retrieved a context from queue
protected void	onMainThreadEnd()
void	resetErrors() Resetes the error count
void	setContextToBuild(CommonContext newContext)
protected void	shutdown()
void	start() Starts the build agent
void	stop() Stops the build agent immediately.
void	stopNicely() Attempt to stop the agent and wait for the current build (if any) to stop building
void	waitForStop(int secondsToWait) Waits a certain number of seconds for a build to stop.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBuildAgent

public DefaultBuildAgent(long agentId,
                         String agentName,
                         @Nullable
                         String agentDescription)

DefaultBuildAgent

@Deprecated
public DefaultBuildAgent(BuildAgentController buildAgentController,
                                     BuildLoggerManager buildLoggerManager,
                                     long agentId,
                                     String agentName,
                                     @Nullable
                                     String agentDescription)

Deprecated. since 5.10, use DefaultBuildAgent(long, String, String)

Method Detail

getId

public long getId()

Description copied from interface: ExecutableBuildAgent

Agent id

Specified by:

getId in interface ExecutableBuildAgent

Returns:

getName

public String getName()

Description copied from interface: ExecutableBuildAgent

Agent name

Specified by:

getName in interface ExecutableBuildAgent

Returns:

getDescription

@NotNull
public String getDescription()

Description copied from interface: ExecutableBuildAgent

Agent description

Specified by:

getDescription in interface ExecutableBuildAgent

start

public void start()

Description copied from interface: ExecutableBuildAgent

Starts the build agent

Specified by:

start in interface ExecutableBuildAgent

onBetweenBuilds

protected void onBetweenBuilds()

onMainThreadEnd

protected void onMainThreadEnd()

build

public void build(@NotNull
                  ReadOnlyCapabilitySet agentCapabilities,
                  @NotNull
                  DockerContainerController dockerContainerController)
           throws Exception

Description copied from interface: ExecutableBuildAgent

Executes the passed CommonContext

Specified by:

build in interface ExecutableBuildAgent

Throws:

Exception

onBuildProcessingFinished

public void onBuildProcessingFinished()

Description copied from interface: ExecutableBuildAgent

This method is called when the build process is completed and the result processing has finished.

Specified by:

onBuildProcessingFinished in interface ExecutableBuildAgent

onContextReceived

public void onContextReceived()

Description copied from interface: ExecutableBuildAgent

This method is called when the agent has just retrieved a context from queue

Specified by:

onContextReceived in interface ExecutableBuildAgent

cancelBuild

public boolean cancelBuild(@NotNull
                           String buildResultKey)

Description copied from interface: ExecutableBuildAgent

Cancels the passed buildResultKey if it matches

Specified by:

cancelBuild in interface ExecutableBuildAgent

executeWithCurrentContext

public <V> V executeWithCurrentContext(Callable<V> callable)
                                throws Exception

Description copied from interface: ExecutableBuildAgent

Execute with guarantee that context will not be switched during execution. (i.e. no new build will be picked up by the agent)

Specified by:

executeWithCurrentContext in interface ExecutableBuildAgent

Throws:

Exception

waitForStop

public void waitForStop(int secondsToWait)
                 throws TimeoutException

Description copied from interface: ExecutableBuildAgent

Waits a certain number of seconds for a build to stop.

Specified by:

waitForStop in interface ExecutableBuildAgent

Parameters:

secondsToWait - -

Throws:

TimeoutException

incrementError

public int incrementError()

Description copied from interface: ExecutableBuildAgent

Tells the agent that an unhandled error has occurred. The agent may then choose to stop the error if a thredhold has been reached. Provides an overload of exceptions being thrown.

Specified by:

incrementError in interface ExecutableBuildAgent

Returns:

resetErrors

public void resetErrors()

Description copied from interface: ExecutableBuildAgent

Resetes the error count

Specified by:

resetErrors in interface ExecutableBuildAgent

isCancelling

public boolean isCancelling()

stop

public void stop()

Description copied from interface: ExecutableBuildAgent

Stops the build agent immediately. Cancelling all currently running builds

Specified by:

stop in interface ExecutableBuildAgent

shutdown

protected void shutdown()

stopNicely

public void stopNicely()

Description copied from interface: ExecutableBuildAgent

Attempt to stop the agent and wait for the current build (if any) to stop building

Specified by:

stopNicely in interface ExecutableBuildAgent

getBuilding

@Nullable
public CommonContext getBuilding()

Description copied from interface: ExecutableBuildAgent

Gets the BuildContext related to the build that is building on the agent. Null if not building or cancelling anything.

Specified by:

getBuilding in interface ExecutableBuildAgent

Returns:

setContextToBuild

public void setContextToBuild(@NotNull
                              CommonContext newContext)

Specified by:

setContextToBuild in interface ExecutableBuildAgent

enable

public void enable()

disable

public void disable()

isEnabled

public boolean isEnabled()

getAgentStatus

public AgentStatus getAgentStatus()

Specified by:

getAgentStatus in interface ExecutableBuildAgent

isStopping

public boolean isStopping()

isActive

public boolean isActive()

Specified by:

isActive in interface ExecutableBuildAgent

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(BuildAgent o)