Package com.atlassian.bamboo.plugins.rest.resource

Class QueueResource

java.lang.Object

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

@Path("queue")
@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
@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

Description

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

Method Summary

Modifier and Type	Method	Description
RestQueuedBuild	continueBuild(String projectKey, String buildKey, Integer buildNumber, String stageName, boolean executeAllStages, javax.ws.rs.core.UriInfo uriInfo)
RestQueuedBuilds	getBuildQueue(javax.ws.rs.core.UriInfo uriInfo)
RestQueuedBuild	startBuild(String projectKey, String buildKey, String stageName, boolean executeAllStages, String customRevision, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext requestContext)
RestQueuedBuild	startBuild(String projectKey, String buildKey, String stageName, boolean executeAllStages, String customRevision, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.MultivaluedHashMap<String,String> formParams)
javax.ws.rs.core.Response	stopBuild(String projectKey, String buildKey, int buildNumber)

Methods inherited from class java.lang.Object

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

Constructor Details

QueueResource

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

Method Details

getBuildQueue

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

startBuild

@POST
@Consumes({"application/xml","application/json"})
@Path("{projectKey : ([^-/]+)}-{buildKey}")
public RestQueuedBuild startBuild(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @QueryParam("stage")
 String stageName,
 @QueryParam("executeAllStages")
 boolean executeAllStages,
 @QueryParam("customRevision")
 String customRevision,
 @Context
 javax.ws.rs.core.UriInfo uriInfo,
 javax.ws.rs.core.MultivaluedHashMap<String,String> formParams)
                           throws WebValidationException

Throws:

WebValidationException

startBuild

@POST
@Consumes("application/x-www-form-urlencoded")
@Path("{projectKey : ([^-/]+)}-{buildKey}")
public RestQueuedBuild startBuild(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @QueryParam("stage")
 String stageName,
 @QueryParam("executeAllStages")
 boolean executeAllStages,
 @QueryParam("customRevision")
 String customRevision,
 @Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.container.ContainerRequestContext requestContext)
                           throws WebValidationException

Throws:

WebValidationException

continueBuild

@PUT
@Consumes({"application/xml","application/json"})
@Path("{projectKey : ([^-/]+)}-{buildKey}-{buildNumber : ([0-9]+)}")
public RestQueuedBuild continueBuild(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 Integer buildNumber,
 @QueryParam("stage")
 String stageName,
 @QueryParam("executeAllStages")
 boolean executeAllStages,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

stopBuild

@DELETE
@Path("{projectKey : ([^-/]+)}-{buildKey}-{buildNumber : ([0-9]+)}")
public javax.ws.rs.core.Response stopBuild(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 int buildNumber)