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

All Superinterfaces:
BuildAgent, java.lang.Comparable<BuildAgent>
All Known Implementing Classes:
DefaultBuildAgent

public interface ExecutableBuildAgent
extends BuildAgent

The ExecutableBuildAgent that is able to be run builds. Basically it's an agent that's "local" to the running directory


Method Summary
 void build(BuildContext currentlyBuilding, ReadOnlyCapabilitySet agentCapabilities)
          Executes the passed BuildContext
 void cancelBuild(java.lang.String buildResultKey)
          Cancels the passed buildResultKey if it matches
 void start()
          Starts the build agent
 void stop()
          Stops the build agent from peeking into the queue
 void waitForStop(int secondsToWait)
          Waits a certain number of seconds for a build to stop.
 
Methods inherited from interface com.atlassian.bamboo.v2.build.agent.BuildAgent
disable, enable, getAgentStatus, getCapabilitySet, getDefinition, getId, getName, isActive, isEnabled, setDefinition
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

start

void start()
Starts the build agent


stop

void stop()
Stops the build agent from peeking into the queue

Throws:
java.lang.InterruptedException

build

void build(@NotNull
           BuildContext currentlyBuilding,
           @NotNull
           ReadOnlyCapabilitySet agentCapabilities)
           throws java.lang.Exception
Executes the passed BuildContext

Parameters:
currentlyBuilding -
agentCapabilities -
Throws:
java.lang.Exception

cancelBuild

void cancelBuild(@NotNull
                 java.lang.String buildResultKey)
Cancels the passed buildResultKey if it matches

Parameters:
buildResultKey -

waitForStop

void waitForStop(int secondsToWait)
                 throws java.util.concurrent.TimeoutException
Waits a certain number of seconds for a build to stop.

Parameters:
secondsToWait - -
Throws:
java.util.concurrent.TimeoutException


Copyright © 2008 Atlassian Pty Ltd. All Rights Reserved.