com.atlassian.bamboo.plugins.rest.resource

Class RepositoryResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.resource.RepositoryResource

public class RepositoryResource
extends Object

Constructor Summary

Constructors

Constructor and Description

RepositoryResource(com.atlassian.sal.api.ApplicationProperties applicationProperties, CachedPlanManager cachedPlanManager, VcsRepositoryManager vcsRepositoryManager, RepositoryDefinitionManager repositoryDefinitionManager, BambooPermissionManager bambooPermissionManager, CustomVariableContext customVariableContext, ValidationService validationService, ValidationFunctionFactory validationFunctionFactory, com.atlassian.sal.api.message.I18nResolver i18nResolver, VcsConfigurationHelper vcsConfigurationHelper, VcsRepositoryConfigurationService vcsRepositoryConfigurationService, RssPermissionManager rssPermissionManager, FeatureManager featureManager, CachedRepositoryDefinitionManager cachedRepositoryDefinitionManager, RssDetectionService rssDetectionService, BambooSpecsManager bambooSpecsManager, com.atlassian.event.api.EventPublisher eventPublisher, SpecsConsumerFactory specsConsumerFactory, EnvironmentService environmentService, ProjectManager projectManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	enableAllProjectsAccess(Map<String,Object> requestData, Long repositoryId) Enables access (i.e.
javax.ws.rs.core.Response	enableAllRepositoriesAccess(Map<String,Object> requestData, Long repositoryId) Enables access (i.e.
javax.ws.rs.core.Response	enableCi(Map<String,Object> requestData, Long repositoryId) Enables or disables detection of Bamboo Specs stored in the repository.
javax.ws.rs.core.Response	enableProjectCreation(Map<String,Object> requestData, Long repositoryId) Enables build and deployment project creation by the Bamboo Specs code stored in this repository.
RestRepositoryList	findRepository(String searchTerm, javax.ws.rs.core.UriInfo uriInfo) Search for existing linked repositories by name.
RestRepositoryUsageModel	findUsage(Long repositoryId, int maxPlans, int maxEnvironments) Search for usages of given repository.
List<RestRepository>	getRssRepositoriesAllowedToAccessRepository(Long targetRepositoryId) Fetch list of RSS repositories which can use given repository by RSS code.
RestVcsLocationSpecsStatus	getSpecsDetectionStatus(long repositoryId, String branch, Integer maxResults) Resource providing status of RSS processing for a given repository and optional branch.
javax.ws.rs.core.Response	grantRssRepositoryAccess(Long targetRepositoryId, RestIdContainer idContainer, javax.ws.rs.core.UriInfo uriInfo) Grant repository with RSS code to use target repository in build plans and deployments.
javax.ws.rs.core.Response	revokePermissionToUseRepositoryByRssRepo(Long targetRepositoryId, Long repositoryId) Revoke access of RSS code stored in repository defined by repositoryId from repository defined by targetRepositoryId.
RestRepositoryList	searchAvailableRepositories(Long targetRepositoryId, String searchTerm, javax.ws.rs.core.UriInfo uriInfo) Search for existing linked repositories which can be granted to use given repository by RSS.
RestBranchList	searchSpecsBranches(long repositoryId, String searchTerm, javax.ws.rs.core.UriInfo uriInfo) Search for divergent branches names (i.e.
RestRepositoryConnectionResult	testConnection(Map<String,Object> requestData) Tests connection to a repository if the repository type supports connection testing.
javax.ws.rs.core.Response	triggerSpecsScanning(Long id, Long repositoryId, String name, String repositoryName) Webhook resource for triggering Repository-stored Bamboo Specs.
javax.ws.rs.core.Response	triggerSpecsScanning(Long repositoryId, String branch) Resource for triggering Repository-stored Bamboo Specs in a 'forced' way.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryResource

public RepositoryResource(com.atlassian.sal.api.ApplicationProperties applicationProperties,
                          CachedPlanManager cachedPlanManager,
                          VcsRepositoryManager vcsRepositoryManager,
                          RepositoryDefinitionManager repositoryDefinitionManager,
                          BambooPermissionManager bambooPermissionManager,
                          CustomVariableContext customVariableContext,
                          ValidationService validationService,
                          ValidationFunctionFactory validationFunctionFactory,
                          com.atlassian.sal.api.message.I18nResolver i18nResolver,
                          VcsConfigurationHelper vcsConfigurationHelper,
                          VcsRepositoryConfigurationService vcsRepositoryConfigurationService,
                          RssPermissionManager rssPermissionManager,
                          FeatureManager featureManager,
                          CachedRepositoryDefinitionManager cachedRepositoryDefinitionManager,
                          RssDetectionService rssDetectionService,
                          BambooSpecsManager bambooSpecsManager,
                          com.atlassian.event.api.EventPublisher eventPublisher,
                          SpecsConsumerFactory specsConsumerFactory,
                          EnvironmentService environmentService,
                          ProjectManager projectManager)

Method Detail

testConnection

public RestRepositoryConnectionResult testConnection(@NotNull
                                                     Map<String,Object> requestData)
                                              throws Exception

Tests connection to a repository if the repository type supports connection testing. Request payload should contain repository configuration.

Throws:

Exception

enableCi

public javax.ws.rs.core.Response enableCi(@NotNull
                                          Map<String,Object> requestData,
                                          Long repositoryId)
                                   throws WebValidationException

Enables or disables detection of Bamboo Specs stored in the repository. If enabled, code changes detected in Bamboo Specs in new commits will trigger execution of Bamboo Specs and thus an update of corresponding entities (such as build plans, deployments or permissions).

Request body is JSON with one attribute :

     { enable: true/false }
 

Parameters:

requestData - request body

repositoryId - id of the repository

Returns:

Response

Throws:

WebValidationException

enableAllProjectsAccess

public javax.ws.rs.core.Response enableAllProjectsAccess(@NotNull
                                                         Map<String,Object> requestData,
                                                         Long repositoryId)
                                                  throws WebValidationException

Enables access (i.e. allowing modifications) for all Bamboo projects by the Bamboo Specs code stored in this repository. Changes in Bamboo Specs detected will trigger execution of Specs and thus an update of corresponding entities (such as build plans or deployments).

Request body is JSON with one attribute :

     { enable: true/false }
 

Parameters:

requestData - request body

repositoryId - id of the repository

Throws:

WebValidationException

enableAllRepositoriesAccess

public javax.ws.rs.core.Response enableAllRepositoriesAccess(@NotNull
                                                             Map<String,Object> requestData,
                                                             Long repositoryId)
                                                      throws WebValidationException

Enables access (i.e. allowing modifications) for all Bamboo linked repositories by the Bamboo Specs code stored in this repository.

Request body is JSON with one attribute :

     { enable: true/false }
 

Parameters:

requestData - request body

repositoryId - id of the repository

Throws:

WebValidationException

enableProjectCreation

public javax.ws.rs.core.Response enableProjectCreation(@NotNull
                                                       Map<String,Object> requestData,
                                                       Long repositoryId)
                                                throws WebValidationException

Enables build and deployment project creation by the Bamboo Specs code stored in this repository.

Request body is JSON with one attribute :

     { enable: true/false }
 

Parameters:

requestData - request body

repositoryId - id of the repository

Throws:

WebValidationException

grantRssRepositoryAccess

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

Grant repository with RSS code to use target repository in build plans and deployments. If permission is not granted RSS import will fail when code tries to use target repository.

Parameters:

targetRepositoryId - target repository id

idContainer - repository id

Returns:

repository which was granted permission to

Throws:

NotFoundException - if repository not found

WebValidationException - if idContainer is empty or null

AccessDeniedException - when user has not administration permission to target repository

searchAvailableRepositories

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

Search for existing linked repositories which can be granted to use given repository by RSS.

Parameters:

targetRepositoryId - target repository id

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

Returns:

page container with linked repositories which are RSS compatible

Throws:

NotFoundException - if repository not found

AccessDeniedException - when user has not administration permission to target repository

getRssRepositoriesAllowedToAccessRepository

public List<RestRepository> getRssRepositoriesAllowedToAccessRepository(Long targetRepositoryId)
                                                                 throws NotFoundException

Fetch list of RSS repositories which can use given repository by RSS code.

Parameters:

targetRepositoryId - target repository id

Returns:

array of repositories granted to use given repository by Repository stored Bamboo Specs.

Throws:

NotFoundException - if repository not found

AccessDeniedException - when user has not administration permission to repository

revokePermissionToUseRepositoryByRssRepo

public javax.ws.rs.core.Response revokePermissionToUseRepositoryByRssRepo(Long targetRepositoryId,
                                                                          Long repositoryId)
                                                                   throws NotFoundException,
                                                                          WebValidationException

Revoke access of RSS code stored in repository defined by repositoryId from repository defined by targetRepositoryId. Use this method when need to prevent usage of target repository by RSS code stored in repository referenced by repositoryId.

Parameters:

targetRepositoryId - target repository id

repositoryId - linked repository root id

Returns:

204

Throws:

NotFoundException - if can't find repository

AccessDeniedException - when user has not administration permission to target repository

WebValidationException

findRepository

public RestRepositoryList findRepository(String searchTerm,
                                         @Context
                                         javax.ws.rs.core.UriInfo uriInfo)

Search for existing linked repositories by name.

Parameters:

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

Returns:

page container with linked repositories which name contains provided searchTerm

searchSpecsBranches

public RestBranchList searchSpecsBranches(long repositoryId,
                                          String searchTerm,
                                          @Context
                                          javax.ws.rs.core.UriInfo uriInfo)
                                   throws WebValidationException

Search for divergent branches names (i.e. vcs branches that have RSS execution results).

Parameters:

repositoryId - ID of the linked repository which stores Bamboo Specs

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

Returns:

page container with matching branches

Throws:

WebValidationException

getSpecsDetectionStatus

public RestVcsLocationSpecsStatus getSpecsDetectionStatus(long repositoryId,
                                                          @Nullable
                                                          String branch,
                                                          @Nullable
                                                          Integer maxResults)

Resource providing status of RSS processing for a given repository and optional branch.

Parameters:

repositoryId - ID of the linked repository which stores Bamboo Specs

branch - optional branch of the repository. Works only if repository supports divergent branches

maxResults - maximum number of spec status entries returned in the response

triggerSpecsScanning

public javax.ws.rs.core.Response triggerSpecsScanning(@Nullable
                                                      Long id,
                                                      @Nullable
                                                      Long repositoryId,
                                                      @Nullable
                                                      String name,
                                                      @Nullable
                                                      String repositoryName)
                                               throws WebValidationException

Webhook resource for triggering Repository-stored Bamboo Specs. Either repository ID or name must be provided via query parameters to identify the linked repository in which Bamboo Specs are defined.

Ambiguous requests, which reference more than one repository via the query params, will result in one parameter taking precedence over the others. There's no guarantee which one.

This resource does not require authorisation. It will always return HTTP 204 response on every valid request, even if the targeted repository doesn't exist or does not contain Bamboo Specs.

Parameters:

id - ID of the linked repository which stores Bamboo Specs

repositoryId - alternative name of the query parameter to provide repository ID

name - unique name of the linked repository which stores Bamboo Specs

repositoryName - alternative name of the query parameter to provide repository name

Throws:

WebValidationException

triggerSpecsScanning

public javax.ws.rs.core.Response triggerSpecsScanning(@NotNull
                                                      Long repositoryId,
                                                      @Nullable
                                                      String branch)
                                               throws WebValidationException

Resource for triggering Repository-stored Bamboo Specs in a 'forced' way. Successful requests to this resource will trigger Bamboo Specs execution even if standard processing would have been skipped (e.g. no new commits to process).

Parameters:

repositoryId - id of the repository to trigger

branch - optional branch of the repository. Works only if repository supports divergent branches

Throws:

WebValidationException

findUsage

public RestRepositoryUsageModel findUsage(@NotNull
                                          Long repositoryId,
                                          int maxPlans,
                                          int maxEnvironments)

Search for usages of given repository.

Parameters:

repositoryId - repository id

maxPlans - maximum count of detailed plans at response. Default is 20.

maxEnvironments - maximum count of detailed environments at response. Default is 20.