com.atlassian.bamboo.plugins.rest.resource

Class QueueResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.resource.QueueResource

@Singleton
public class QueueResource
extends Object

Lists all the builds waiting in the build queue, adds or removes a build from the build queue. May be used also to resume build on manual stage or rerun failed jobs.

Constructor Summary

Constructors

Constructor and Description
QueueResource(PlanRestService planRestService, BambooPermissionManager bambooPermissionManager, BambooUserManager bambooUserManager, BuildQueueManager buildQueueManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, PlanExecutionManager planExecutionManager, ResultsSummaryManager resultsSummaryManager)

Method Summary

Modifier and Type	Method and Description
RestQueuedBuild	continueBuild(String projectKey, String buildKey, Integer buildNumber, String stageName, boolean executeAllStages, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Continue partially done build.
RestQueuedBuilds	getBuildQueue(javax.ws.rs.core.UriInfo uriInfo) Provide list of build scheduled for execution and waiting in build queue.
RestQueuedBuild	startBuild(String projectKey, String buildKey, String stageName, boolean executeAllStages, String customRevision, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext, String fakeParam, javax.ws.rs.core.MultivaluedMap<String,String> formParams) Fire build execution for specified plan.
javax.ws.rs.core.Response	stopBuild(String projectKey, String buildKey, int buildNumber) Stop build execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueueResource

public QueueResource(PlanRestService planRestService,
                     BambooPermissionManager bambooPermissionManager,
                     BambooUserManager bambooUserManager,
                     BuildQueueManager buildQueueManager,
                     com.atlassian.sal.api.message.I18nResolver i18nResolver,
                     PlanExecutionManager planExecutionManager,
                     ResultsSummaryManager resultsSummaryManager)

Method Detail

getBuildQueue

public RestQueuedBuilds getBuildQueue(@Context
                                      javax.ws.rs.core.UriInfo uriInfo)

Provide list of build scheduled for execution and waiting in build queue.

startBuild

public RestQueuedBuild startBuild(String projectKey,
                                  String buildKey,
                                  String stageName,
                                  boolean executeAllStages,
                                  String customRevision,
                                  @Context
                                  javax.ws.rs.core.UriInfo uriInfo,
                                  @Context
                                  com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext,
                                  String fakeParam,
                                  javax.ws.rs.core.MultivaluedMap<String,String> formParams)
                           throws WebValidationException

Fire build execution for specified plan. Effectively, this method adds build to the build queue, so is not guarantied that build would be executed immediately. Depending on currently executed builds and length of build queue, build may be executed when queue would be drained. Additional variables could be passed to this method either as form encoded POST payload or query parameters. PLEASE note: Query parameters are more important - override those stored in form payload. Variables defined in Bamboo as global variables or plan variables MUST be prefixed with bamboo.variable ie. bamboo.variable.myVariable=valueForMyVariable. When global or plan variables would be passed to this method, will override default values for variables.

Parameters:

projectKey - project key

buildKey - plan key (only top level plan key, can not be job key)

stageName - name of the stage that should be executed even if defined as manual stage. Execution will follow to the next manual stage after this or end of plan if no subsequent manual stage

executeAllStages - enforce executing all stages in a plan, even if defined as manual stages. Execution will follow and include latest stage, unless some stage will fail.

customRevision - execute this plan for a custom revision instead of the latest one

uriInfo - uri info

authenticationContext - authentication context

Returns:

RestQueuedBuild

Throws:

WebValidationException

continueBuild

public RestQueuedBuild continueBuild(String projectKey,
                                     String buildKey,
                                     Integer buildNumber,
                                     String stageName,
                                     boolean executeAllStages,
                                     @Context
                                     javax.ws.rs.core.UriInfo uriInfo,
                                     @Context
                                     com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Continue partially done build. Effectively, this method adds build to the build queue, so is not guarantied that build would be executed immediately. Depending on currently executed builds and length of build queue, build may be executed when queue would be drained. Additional variables could be passed to this method only query parameters (variableName=variableValue). Variables defined in Bamboo as global variables or plan variables MUST be prefixed with bamboo.variable ie. bamboo.variable.myVariable=valueForMyVariable. When global or plan variables would be passed to this method, will override values valid for previous build execution (override).

Parameters:

projectKey - project key

buildKey - plan key (only top level plan key, can not be job key)

buildNumber - build number to resume/rerun

stageName - name of the stage that should be executed even if manual stage. Execution will follow to the next manual stage after this or end of plan if no subsequent manual stage

executeAllStages - enforce executing all stages in a plan, even if defined as manual stages. Execution will follow and include latest stage, unless some stage will fail.

uriInfo - uri info

authenticationContext - authentication context

Returns:

RestQueuedBuild

stopBuild

public javax.ws.rs.core.Response stopBuild(String projectKey,
                                           String buildKey,
                                           int buildNumber)

Stop build execution.

Parameters:

projectKey - project key

buildKey - plan key - IMPORTANT: as build queue contains only jobs not top level plans, plan key here MUST be a job key as opposite to other methods in this resource.

buildNumber - build number