com.atlassian.bamboo.plugins.rest.deployments.projects

Class DeploymentProjectResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.deployments.projects.DeploymentProjectResource

@Singleton
public class DeploymentProjectResource
extends Object

Constructor Summary

Constructors

Constructor and Description

DeploymentProjectResource(AdministrationConfigurationAccessor administrationConfigurationAccessor, BambooPermissionManager bambooPermissionManager, BambooUserManager bambooUserManager, DeploymentProjectService deploymentProjectService, EnvironmentService environmentService, DeploymentVersionService deploymentVersionService, com.atlassian.sal.api.message.I18nResolver i18nResolver, LinkedDeploymentProjectCacheService linkedDeploymentProjectCacheService, ResultsSummaryManager resultsSummaryManager)

Method Summary

Modifier and Type	Method and Description
RestDeploymentProject	addDeploymentProject(RestCreateDeploymentProjectRequest createDeploymentProjectRequest) Create deployment project.
RestDeploymentVersion	createVersion(long deploymentProjectId, RestCreateVersionRequest createVersionRequest, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Create deployment version for given deployment project.
RestDeploymentProject	editDeploymentProject(long deploymentProjectId, RestUpdateDeploymentProjectRequest updateDeploymentProjectRequest) Update deployment project.
List<RestDeploymentProject>	getAllDeploymentProjects() Find all deployment projects with environments.
RestDeploymentProject	getDeploymentProject(long deploymentProjectId) Find deployment project by id.
List<RestLinkedDeploymentProject>	getDeploymentProjectsForPlan(String planKey) Get list of deployment projects for build plan.
RestDeploymentVersionList	getDeploymentProjectVersions(long deploymentProjectId, String planBranchKey, javax.ws.rs.core.UriInfo uriInfo) Get list of deployment versions by deployment project id

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentProjectResource

public DeploymentProjectResource(AdministrationConfigurationAccessor administrationConfigurationAccessor,
                                 BambooPermissionManager bambooPermissionManager,
                                 BambooUserManager bambooUserManager,
                                 DeploymentProjectService deploymentProjectService,
                                 EnvironmentService environmentService,
                                 DeploymentVersionService deploymentVersionService,
                                 com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                 LinkedDeploymentProjectCacheService linkedDeploymentProjectCacheService,
                                 ResultsSummaryManager resultsSummaryManager)

Method Detail

getAllDeploymentProjects

public List<RestDeploymentProject> getAllDeploymentProjects()
                                                     throws Exception

Find all deployment projects with environments. Returns only deployment projects and environments visible for user.

Throws:

Exception

addDeploymentProject

public RestDeploymentProject addDeploymentProject(@Nullable
                                                  RestCreateDeploymentProjectRequest createDeploymentProjectRequest)
                                           throws WebValidationException

Create deployment project.

Parameters:

createDeploymentProjectRequest - deployment project to be created

Returns:

RestDeploymentProject

Throws:

WebValidationException

getDeploymentProject

public RestDeploymentProject getDeploymentProject(long deploymentProjectId)

Find deployment project by id.

Parameters:

deploymentProjectId - deployment project id

Returns:

restDeploymentProject

editDeploymentProject

public RestDeploymentProject editDeploymentProject(long deploymentProjectId,
                                                   @Nullable
                                                   RestUpdateDeploymentProjectRequest updateDeploymentProjectRequest)
                                            throws WebValidationException

Update deployment project.

Parameters:

deploymentProjectId - deployment project id

updateDeploymentProjectRequest - deployment project

Returns:

updated RestDeploymentProject

Throws:

WebValidationException

getDeploymentProjectVersions

public RestDeploymentVersionList getDeploymentProjectVersions(long deploymentProjectId,
                                                              @Nullable
                                                              String planBranchKey,
                                                              @Context
                                                              javax.ws.rs.core.UriInfo uriInfo)

Get list of deployment versions by deployment project id

Parameters:

deploymentProjectId - deployment project id

planBranchKey - plan branch key. Can be empty if default branch is required

uriInfo - uri info

Returns:

RestDeploymentVersionList

createVersion

public RestDeploymentVersion createVersion(long deploymentProjectId,
                                           @Nullable
                                           RestCreateVersionRequest createVersionRequest,
                                           @Context
                                           com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
                                    throws WebValidationException,
                                           org.acegisecurity.AccessDeniedException

Create deployment version for given deployment project.

Parameters:

deploymentProjectId - id of deployment project

createVersionRequest - payload

authenticationContext - authentication context

Returns:

RestDeploymentVersion

Throws:

WebValidationException

org.acegisecurity.AccessDeniedException

getDeploymentProjectsForPlan

public List<RestLinkedDeploymentProject> getDeploymentProjectsForPlan(@Nullable
                                                                      String planKey)
                                                               throws WebValidationException

Get list of deployment projects for build plan.

Parameters:

planKey - plan key. Required

Returns:

list of RestLinkedDeploymentProject

Throws:

WebValidationException