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, com.atlassian.sal.api.ApplicationProperties applicationProperties, BambooPermissionManager bambooPermissionManager, BambooUserManager bambooUserManager, DeploymentProjectService deploymentProjectService, DeploymentVersionService deploymentVersionService, EnvironmentService environmentService, FeatureManager featureManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, LinkedDeploymentProjectCacheService linkedDeploymentProjectCacheService, RepositoryDefinitionManager repositoryDefinitionManager, CachedRepositoryDefinitionManager cachedRepositoryDefinitionManager, ResultsSummaryManager resultsSummaryManager, RssPermissionManager rssPermissionManager, DeploymentProjectDeletionService deploymentProjectDeletionService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addAssignedRepository(Long deploymentProjectId, RestIdContainer idContainer, javax.ws.rs.core.UriInfo uriInfo) Grant permission to create/edit plan in given deployment project by Bamboo Specs from given repository.
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.
javax.ws.rs.core.Response	deleteDeploymentProject(long deploymentProjectId) Delete deployment project
javax.ws.rs.core.Response	deleteRepositoryMapping(Long deploymentProjectId, Long repositoryId) Remove approval to create plans in given deployment project by given repository
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
List<RestRepository>	listAssignedRepositories(Long deploymentProjectId) Fetch list of repositories which granted to create/edit environment in given deployment project by Repository stored Bamboo Specs.
RestRepositoryList	searchAvailableRepositories(long deploymentProjectId, String searchTerm, javax.ws.rs.core.UriInfo uriInfo) Search for linked repositories which can be granted to create/modify environment by Repository stored Bamboo Specs in given deployment project.

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,
                                 com.atlassian.sal.api.ApplicationProperties applicationProperties,
                                 BambooPermissionManager bambooPermissionManager,
                                 BambooUserManager bambooUserManager,
                                 DeploymentProjectService deploymentProjectService,
                                 DeploymentVersionService deploymentVersionService,
                                 EnvironmentService environmentService,
                                 FeatureManager featureManager,
                                 com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                 LinkedDeploymentProjectCacheService linkedDeploymentProjectCacheService,
                                 RepositoryDefinitionManager repositoryDefinitionManager,
                                 CachedRepositoryDefinitionManager cachedRepositoryDefinitionManager,
                                 ResultsSummaryManager resultsSummaryManager,
                                 RssPermissionManager rssPermissionManager,
                                 DeploymentProjectDeletionService deploymentProjectDeletionService)

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

listAssignedRepositories

public List<RestRepository> listAssignedRepositories(Long deploymentProjectId)
                                              throws NotFoundException

Fetch list of repositories which granted to create/edit environment in given deployment project by Repository stored Bamboo Specs. Returns json array: [{"id":"123", "name":"repo1", "url":"http://localhost:8085/admin/configureLinkedRepositories.action?repositoryId=123"}]

Parameters:

deploymentProjectId - deployment project id

Returns:

array of repositories granted to create/edit environment in given deployment project by Repository stored Bamboo Specs.

Throws:

NotFoundException - if project not found

AccessDeniedException - when user has not administration permission to project

addAssignedRepository

public javax.ws.rs.core.Response addAssignedRepository(Long deploymentProjectId,
                                                       @Nullable
                                                       RestIdContainer idContainer,
                                                       @Context
                                                       javax.ws.rs.core.UriInfo uriInfo)
                                                throws NotFoundException,
                                                       WebValidationException

Grant permission to create/edit plan in given deployment project by Bamboo Specs from given repository.

Parameters:

deploymentProjectId - project key

idContainer - repository id

Returns:

added repository

Throws:

NotFoundException - if project or repository not found

WebValidationException - if idContainer is empty or null

AccessDeniedException - when user has not administration permission to project

deleteRepositoryMapping

public javax.ws.rs.core.Response deleteRepositoryMapping(Long deploymentProjectId,
                                                         Long repositoryId)
                                                  throws NotFoundException

Remove approval to create plans in given deployment project by given repository

Parameters:

deploymentProjectId - project key

repositoryId - linked repository root id

Returns:

204

Throws:

NotFoundException - if can't find project or repository

AccessDeniedException - when user has not administration permission to project

searchAvailableRepositories

public RestRepositoryList searchAvailableRepositories(long deploymentProjectId,
                                                      String searchTerm,
                                                      @Context
                                                      javax.ws.rs.core.UriInfo uriInfo)
                                               throws NotFoundException

Search for linked repositories which can be granted to create/modify environment by Repository stored Bamboo Specs in given deployment project.

Parameters:

deploymentProjectId - deployment project

searchTerm - part of repository name. Used to filter output.

Returns:

page container with linked repositories which have RSS enabled

Throws:

NotFoundException - if project not found

AccessDeniedException - when user has not administration permission to project

deleteDeploymentProject

public javax.ws.rs.core.Response deleteDeploymentProject(long deploymentProjectId)

Delete deployment project

Parameters:

deploymentProjectId - deployment project

Returns:

204 if deployment project removed

Throws:

NotFoundException - if deployment project not found

AccessDeniedException - when user lacks administration permission to deployment project