com.atlassian.bamboo.plugins.rest.deployments.execution

Class DeploymentQueueResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.deployments.execution.DeploymentQueueResource

@Singleton
public class DeploymentQueueResource
extends Object

Constructor Summary

Constructors

Constructor and Description

DeploymentQueueResource(BuildQueueManager buildQueueManager, BambooUserManager bambooUserManager, DeploymentExecutionService deploymentExecutionService, DeploymentProjectService deploymentProjectService, DeploymentResultService deploymentResultService, DeploymentVersionService deploymentVersionService, EnvironmentService environmentService, EnvironmentTriggeringActionFactory environmentTriggeringActionFactory, com.atlassian.sal.api.message.I18nResolver i18nResolver, PlanExecutionManager planExecutionManager)

Method Summary

Modifier and Type	Method and Description
RestQueuedDeployments	getBuildQueue(String expandParam, javax.ws.rs.core.UriInfo uriInfo) Provide list of deployment results scheduled for execution and waiting in queue.
javax.ws.rs.core.Response	removeDeploymentFromQueue(Long deploymentResultId, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Remove deployment result from queue.
RestQueuedDeployment	startDeployment(Long environmentId, Long versionId, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Trigger deployment for deployment environment and version.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentQueueResource

public DeploymentQueueResource(BuildQueueManager buildQueueManager,
                               BambooUserManager bambooUserManager,
                               DeploymentExecutionService deploymentExecutionService,
                               DeploymentProjectService deploymentProjectService,
                               DeploymentResultService deploymentResultService,
                               DeploymentVersionService deploymentVersionService,
                               EnvironmentService environmentService,
                               EnvironmentTriggeringActionFactory environmentTriggeringActionFactory,
                               com.atlassian.sal.api.message.I18nResolver i18nResolver,
                               PlanExecutionManager planExecutionManager)

Method Detail

getBuildQueue

public RestQueuedDeployments getBuildQueue(String expandParam,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo)

Provide list of deployment results scheduled for execution and waiting in queue.

Parameters:

expandParam - expands deployment result queue items on request. Possible value: queuedDeployments.

uriInfo - request details

startDeployment

public RestQueuedDeployment startDeployment(@Nullable
                                            Long environmentId,
                                            @Nullable
                                            Long versionId,
                                            @Context
                                            javax.ws.rs.core.UriInfo uriInfo,
                                            @Context
                                            com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
                                     throws WebValidationException,
                                            org.acegisecurity.AccessDeniedException

Trigger deployment for deployment environment and version.

Parameters:

environmentId - Deployment environment id. Mandatory

versionId - Version (release) id. Mandatory

uriInfo - request details

authenticationContext - authentication context

Returns:

deployment result added to queue

Throws:

WebValidationException

org.acegisecurity.AccessDeniedException

removeDeploymentFromQueue

public javax.ws.rs.core.Response removeDeploymentFromQueue(Long deploymentResultId,
                                                           @Context
                                                           com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
                                                    throws WebValidationException

Remove deployment result from queue.

Parameters:

deploymentResultId - id of deployment result in queue.

authenticationContext - authentication context

Returns:

204 HTTP status if deployment result was removed from queue

Throws:

WebValidationException