com.atlassian.bamboo.v2.build.agent
Interface BuildAgent

All Superinterfaces:
java.lang.Comparable<BuildAgent>
All Known Subinterfaces:
LocalBuildAgent
All Known Implementing Classes:
BuildAgentImpl, LocalBuildAgentImpl

public interface BuildAgent
extends java.lang.Comparable<BuildAgent>

Represents a UI view of a given build agent


Nested Class Summary
static interface BuildAgent.BuildAgentVisitor
          A visitor to execute certain flows depending on the type of the BuildAgent
 
Method Summary
 void accept(BuildAgent.BuildAgentVisitor buildAgentVisitor)
          Runs the appropriate visitor method depending on which type of agent it is
 AgentStatus getAgentStatus()
           
 PipelineDefinition getDefinition()
           
 long getId()
           
 java.lang.String getName()
           
 boolean isActive()
           
 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(PipelineDefinition definition)
           
 void setRequestedToBeStopped(boolean requestedToBeStopped)
           
 void setUnresponsive(boolean unresponsive)
           
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getId

long getId()

getName

java.lang.String getName()

isActive

boolean isActive()

isEnabled

boolean isEnabled()

getAgentStatus

AgentStatus getAgentStatus()

getDefinition

@NotNull
PipelineDefinition getDefinition()

setDefinition

void setDefinition(@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)


Copyright © 2009 Atlassian Pty Ltd. All Rights Reserved.