Package com.atlassian.bamboo.v2.build.agent

Interface BuildAgent

All Superinterfaces:

BambooIdProvider, Comparable<BuildAgent>, NameProvider

All Known Subinterfaces:

LocalBuildAgent

All Known Implementing Classes:

BuildAgentDecorator, BuildAgentImpl, LocalBuildAgentImpl

public interface BuildAgent
extends Comparable<BuildAgent>, NameProvider, BambooIdProvider

Represents a UI view of a given build agent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BuildAgent.BuildAgentVisitor	A visitor to execute certain flows depending on the type of the BuildAgent

Field Summary

Fields

Modifier and Type	Field	Description
static String	EPHEMERAL_AGENT_TEMPLATE_ID_KEY
static String	EPHEMERAL_AGENT_TEMPLATE_NAME_KEY

Method Summary

Modifier and Type	Method	Description
void	accept(BuildAgent.BuildAgentVisitor buildAgentVisitor)	Runs the appropriate visitor method depending on which type of agent it is
@NotNull AgentStatus	getAgentStatus()
@NotNull PipelineDefinition	getDefinition()
long	getId()
@NotNull String	getName()
AgentType	getType()
boolean	isActive()
boolean	isBusy()	Returns true if an agent is building or is cancelling a build
boolean	isDedicated()	Deprecated. without replacement; this is temporary solution
boolean	isEnabled()
boolean	isRequestedToBeStopped()	Whether or not a call has been made to shutdown the agent after the current build has finished
boolean	isUnresponsive()	Whether or not the agent has been deemed to be "unresponsive".
void	setDefinition(@NotNull PipelineDefinition definition)
void	setRequestedToBeStopped(boolean requestedToBeStopped)
void	setUnresponsive(boolean unresponsive)

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

EPHEMERAL_AGENT_TEMPLATE_ID_KEY

static final String EPHEMERAL_AGENT_TEMPLATE_ID_KEY

See Also:

Constant Field Values

EPHEMERAL_AGENT_TEMPLATE_NAME_KEY

static final String EPHEMERAL_AGENT_TEMPLATE_NAME_KEY

See Also:

Constant Field Values

Method Detail

getId

long getId()

Specified by:

getId in interface BambooIdProvider

getName

@NotNull
@NotNull String getName()

Specified by:

getName in interface NameProvider

getType

AgentType getType()

isActive

boolean isActive()

isEnabled

boolean isEnabled()

getAgentStatus

@NotNull
@NotNull AgentStatus getAgentStatus()

getDefinition

@NotNull
@NotNull PipelineDefinition getDefinition()

setDefinition

void setDefinition(@NotNull
                   @NotNull PipelineDefinition definition)

isRequestedToBeStopped

boolean isRequestedToBeStopped()

Whether or not a call has been made to shutdown the agent after the current build has finished

Returns:

setRequestedToBeStopped

void setRequestedToBeStopped(boolean requestedToBeStopped)

accept

void accept(BuildAgent.BuildAgentVisitor buildAgentVisitor)

Runs the appropriate visitor method depending on which type of agent it is

Parameters:

buildAgentVisitor -

isUnresponsive

boolean isUnresponsive()

Whether or not the agent has been deemed to be "unresponsive". Agents will be first marked as unresponsive before they are made offline.

Used for remote agents.

Returns:

setUnresponsive

void setUnresponsive(boolean unresponsive)

isBusy

boolean isBusy()

Returns true if an agent is building or is cancelling a build

Returns:

isDedicated

@Deprecated
boolean isDedicated()

Deprecated.

without replacement; this is temporary solution