com.atlassian.bamboo.plugins.rest.resource

Class ProjectResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.resource.ProjectResource

public class ProjectResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static RestRepositoryList	SEARCH_AVAILABLE_REPOSITORIES_EXAMPLE

Constructor Summary

Constructors

Constructor and Description

ProjectResource(com.atlassian.sal.api.ApplicationProperties applicationProperties, BambooPermissionManager bambooPermissionManager, BambooUserManager bambooUserManager, CachedPlanManager cachedPlanManager, FeatureManager featureManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, LabelManager labelManager, ProjectManager projectManager, PlanRestService planRestService, RepositoryDefinitionManager repositoryDefinitionManager, CachedRepositoryDefinitionManager cachedRepositoryDefinitionManager, RssPermissionManager rssPermissionManager, ProjectConfigurationService projectConfigurationService, SpecsExporter specsExporter, VariableDefinitionManager variableDefinitionManager, VariableConfigurationService variableConfigurationService, CredentialsManager credentialsManager, PaginatedDataCollector paginatedDataCollector, VcsRepositoryManager vcsRepositoryManager, LinkService linkService, SharedCredentialConversionFunction sharedCredentialConversionFunction)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addAssignedRepository(String projectKey, RestIdContainer idContainer, javax.ws.rs.core.UriInfo uriInfo) Grant permission to create/edit plan in given project by Bamboo Specs from given repository.
javax.ws.rs.core.Response	createOrUpdateVariable(String projectKey, RestVariable request) Create or update project variable.
javax.ws.rs.core.Response	createProject(RestProject request, javax.ws.rs.core.UriInfo uriInfo) Create project.
javax.ws.rs.core.Response	deleteProject(String projectKey) Marks project for deletion.
javax.ws.rs.core.Response	deleteProjectSharedCredentials(String projectKey, long sharedCredentialsId) Deletes shared project credentials specified by id
javax.ws.rs.core.Response	deleteRepositoryMapping(String projectKey, Long repositoryId) Remove approval to create plans in given project by given repository
javax.ws.rs.core.Response	exportProjectSpecs(String projectKey, String packageNameOpt, String formatParam) Export all of the plans for a project to Bamboo specs
RestPageModel<RestProjectRepository>	getPaginatedProjectRepositories(String projectKey, String filter, PageRequest pageRequest, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders) Retrieves paginated project repositories specified by the project key.
RestPageModel<RestSharedCredential>	getPaginatedProjectSharedCredentials(String projectKey, String filter, PageRequest pageRequest, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders) Retrieves paginated shared credentials for the project specified by the project key.
RestProject	getProject(String projectKey, boolean showEmpty, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Method used to retrieve information for project specified as project key.
RestProjects	getProjects(boolean showEmpty, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Method used to list all projects defined in Bamboo.
List<RestRepository>	listAssignedRepositories(String projectKey) Fetch list of repositories which granted to create plan in given project by Repository stored Bamboo Specs.
RestRepositoryList	searchAvailableRepositories(String projectKey, String searchTerm, javax.ws.rs.core.UriInfo uriInfo) Search for linked repositories which can be granted to create plans by Repository stored Bamboo Specs in given project

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_AVAILABLE_REPOSITORIES_EXAMPLE

public static final RestRepositoryList SEARCH_AVAILABLE_REPOSITORIES_EXAMPLE

Constructor Detail

ProjectResource

public ProjectResource(com.atlassian.sal.api.ApplicationProperties applicationProperties,
                       BambooPermissionManager bambooPermissionManager,
                       BambooUserManager bambooUserManager,
                       CachedPlanManager cachedPlanManager,
                       FeatureManager featureManager,
                       com.atlassian.sal.api.message.I18nResolver i18nResolver,
                       LabelManager labelManager,
                       ProjectManager projectManager,
                       PlanRestService planRestService,
                       RepositoryDefinitionManager repositoryDefinitionManager,
                       CachedRepositoryDefinitionManager cachedRepositoryDefinitionManager,
                       RssPermissionManager rssPermissionManager,
                       ProjectConfigurationService projectConfigurationService,
                       SpecsExporter specsExporter,
                       VariableDefinitionManager variableDefinitionManager,
                       VariableConfigurationService variableConfigurationService,
                       CredentialsManager credentialsManager,
                       PaginatedDataCollector paginatedDataCollector,
                       VcsRepositoryManager vcsRepositoryManager,
                       LinkService linkService,
                       SharedCredentialConversionFunction sharedCredentialConversionFunction)

Method Detail

getProjects

public RestProjects getProjects(boolean showEmpty,
                                @Context
                                javax.ws.rs.core.UriInfo uriInfo,
                                @Context
                                com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Method used to list all projects defined in Bamboo. Projects without any plan are not listed by default, unless showEmpty query param is set to true.

Possible expand parameters:

projects

list of projects projects.project - list of projects with project details

projects.project.plans

list of project details and plans for project

projects.project.plans.plan

list of project details and plans for project with plan details

Parameters:

showEmpty - flag to display projects without plans

Returns:

list of Bamboo projects

getProject

public RestProject getProject(String projectKey,
                              boolean showEmpty,
                              @Context
                              javax.ws.rs.core.UriInfo uriInfo,
                              @Context
                              com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Method used to retrieve information for project specified as project key.

Possible expand parameters:

plans

list of plans for project

plans.plan

list of plans with plan details (only plans visible - READ permission for user)

plans.plan.actions

list of plans with plan details and actions available for user for plan

Parameters:

projectKey - project key

showEmpty - flag to return project without plans

Returns:

project data (optionally plan info and plan details)

getPaginatedProjectRepositories

public RestPageModel<RestProjectRepository> getPaginatedProjectRepositories(String projectKey,
                                                                            String filter,
                                                                            @Context
                                                                            PageRequest pageRequest,
                                                                            @Context
                                                                            javax.ws.rs.core.UriInfo uriInfo,
                                                                            @Context
                                                                            javax.ws.rs.core.HttpHeaders httpHeaders)

Retrieves paginated project repositories specified by the project key.

Parameters:

projectKey - project key

pageRequest - represents the params that define which page the request is after

uriInfo - URI info from the request

filter - filter to retrieve matching results

httpHeaders - headers of the request

Returns:

rest page model

addAssignedRepository

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

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

Parameters:

projectKey - 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

searchAvailableRepositories

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

Search for linked repositories which can be granted to create plans by Repository stored Bamboo Specs in given project

Parameters:

projectKey - project key

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

listAssignedRepositories

public List<RestRepository> listAssignedRepositories(String projectKey)
                                              throws NotFoundException

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

Parameters:

projectKey - project key

Returns:

array of repositories granted to create plan in given project by Repository stored Bamboo Specs.

Throws:

NotFoundException - if project not found

AccessDeniedException - when user has not administration permission to project

deleteRepositoryMapping

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

Remove approval to create plans in given project by given repository

Parameters:

projectKey - 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

deleteProject

public javax.ws.rs.core.Response deleteProject(String projectKey)
                                        throws NotFoundException,
                                               NotAuthorizedException

Marks project for deletion. Project will be deleted by a batch job.

Parameters:

projectKey - project key

Throws:

NotFoundException - if project not found

AccessDeniedException - when user has not administration permission to project

NotAuthorizedException

createProject

public javax.ws.rs.core.Response createProject(@Nullable
                                               RestProject request,
                                               @Context
                                               javax.ws.rs.core.UriInfo uriInfo)
                                        throws WebValidationException

Create project.

Parameters:

request -

Throws:

WebValidationException - when validation error happens.

AccessDeniedException - when user don't have global CREATE permission.

createOrUpdateVariable

public javax.ws.rs.core.Response createOrUpdateVariable(String projectKey,
                                                        @Nullable
                                                        RestVariable request)
                                                 throws WebValidationException

Create or update project variable.

Parameters:

projectKey - project key

request - variable

Throws:

WebValidationException - when validation error happens.

AccessDeniedException - when user don't have global ADMINISTRATION permission.

getPaginatedProjectSharedCredentials

public RestPageModel<RestSharedCredential> getPaginatedProjectSharedCredentials(String projectKey,
                                                                                String filter,
                                                                                @Context
                                                                                PageRequest pageRequest,
                                                                                @Context
                                                                                javax.ws.rs.core.UriInfo uriInfo,
                                                                                @Context
                                                                                javax.ws.rs.core.HttpHeaders httpHeaders)
                                                                         throws WebValidationException,
                                                                                NotFoundException

Retrieves paginated shared credentials for the project specified by the project key.

Parameters:

projectKey - project key

pageRequest - represents the params that define which page the request is after

uriInfo - URI info from the request

filter - filter to retrieve matching results

httpHeaders - headers of the request

Returns:

rest page model

Throws:

WebValidationException

NotFoundException

deleteProjectSharedCredentials

public javax.ws.rs.core.Response deleteProjectSharedCredentials(String projectKey,
                                                                long sharedCredentialsId)

Deletes shared project credentials specified by id

Parameters:

projectKey - project key

sharedCredentialsId - project shared credentials id

Throws:

NotFoundException - if credentials are global or not found

AccessDeniedException - if credentials exist but belong to different project

exportProjectSpecs

public javax.ws.rs.core.Response exportProjectSpecs(String projectKey,
                                                    String packageNameOpt,
                                                    @Nullable
                                                    String formatParam)

Export all of the plans for a project to Bamboo specs

Parameters:

projectKey - The project to export for

Returns:

All of the exported specs