Package com.atlassian.bamboo.plugins.rest.resource

Class ProjectResource

java.lang.Object

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

@Path("project")
@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
public class ProjectResource
extends Object

Constructor Summary

Constructors

Constructor

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, RestAuthenticationContext restAuthenticationContext)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addAssignedRepository(String projectKey, @Nullable RestIdContainer idContainer, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	createOrUpdateVariable(String projectKey, @Nullable RestVariable request, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	createProject(@Nullable RestProjectCreate request, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	deleteProject(String projectKey)
jakarta.ws.rs.core.Response	deleteProjectSharedCredentials(String projectKey, long sharedCredentialsId)
jakarta.ws.rs.core.Response	deleteProjectVariable(String projectKey, String variableName)
jakarta.ws.rs.core.Response	deleteRepositoryMapping(String projectKey, Long repositoryId)
jakarta.ws.rs.core.Response	enableAllRepositoriesAccess(String projectKey, Long repositoryId, RepositoryResource.RestEnableContainer enableContainer)
jakarta.ws.rs.core.Response	exportProjectSpecs(String projectKey, String packageNameOpt, @Nullable String formatParam)
RestPageModel<RestProjectRepository>	getPaginatedProjectRepositories(String projectKey, String filter, PageRequest pageRequest, jakarta.ws.rs.core.UriInfo uriInfo)
RestPageModel<RestSharedCredential>	getPaginatedProjectSharedCredentials(String projectKey, String filter, PageRequest pageRequest, jakarta.ws.rs.core.UriInfo uriInfo)
RestProject	getProject(String projectKey, boolean showEmpty, jakarta.ws.rs.core.UriInfo uriInfo)
RestProjects	getProjects(boolean showEmpty, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	getProjectVariable(String projectKey, String variableName)
jakarta.ws.rs.core.Response	getProjectVariables(String projectKey)
List<RestRepository>	listAssignedRepositories(String projectKey)
RestRepositoryList	searchAvailableRepositories(String projectKey, String searchTerm, jakarta.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectResource

@Inject
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,
 RestAuthenticationContext restAuthenticationContext)

Method Details

getProjects

@GET
public RestProjects getProjects(@QueryParam("showEmpty")
 boolean showEmpty,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getProject

@GET
@Path("{projectKey : ([^-/]+)}")
public RestProject getProject(@PathParam("projectKey")
 String projectKey,
 @DefaultValue("true") @QueryParam("showEmpty")
 boolean showEmpty,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getPaginatedProjectRepositories

@GET
@Path("/{projectKey : ([^-/]+)}/repositories")
public RestPageModel<RestProjectRepository> getPaginatedProjectRepositories(@PathParam("projectKey")
 String projectKey,
 @QueryParam("filter") @DefaultValue("")
 String filter,
 @BeanParam
 PageRequest pageRequest,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

addAssignedRepository

@POST
@Path("{projectKey : ([^-/]+)}/repository")
public jakarta.ws.rs.core.Response addAssignedRepository(@PathParam("projectKey")
 String projectKey,
 @Nullable
 @Nullable RestIdContainer idContainer,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                                  throws NotFoundException,
WebValidationException

Throws:

NotFoundException

WebValidationException

searchAvailableRepositories

@GET
@Path("{projectKey : ([^-/]+)}/repository/search")
public RestRepositoryList searchAvailableRepositories(@PathParam("projectKey")
 String projectKey,
 @QueryParam("searchTerm")
 String searchTerm,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                               throws NotFoundException

Throws:

NotFoundException

listAssignedRepositories

@GET
@Consumes("application/json")
@Produces("application/json")
@Path("{projectKey : ([^-/]+)}/repository")
public List<RestRepository> listAssignedRepositories(@PathParam("projectKey")
 String projectKey)
                                              throws NotFoundException

Throws:

NotFoundException

deleteRepositoryMapping

@DELETE
@Path("{projectKey : ([^-/]+)}/repository/{repositoryId}")
public jakarta.ws.rs.core.Response deleteRepositoryMapping(@PathParam("projectKey")
 String projectKey,
 @PathParam("repositoryId")
 Long repositoryId)
                                                    throws NotFoundException

Throws:

NotFoundException

enableAllRepositoriesAccess

@PUT
@Path("{projectKey : ([^-/]+)}/repository/{repositoryId}/enableAllRepositoriesAccess")
public jakarta.ws.rs.core.Response enableAllRepositoriesAccess(@PathParam("projectKey")
 String projectKey,
 @PathParam("repositoryId")
 Long repositoryId,
 @Nullable
 RepositoryResource.RestEnableContainer enableContainer)
                                                        throws WebValidationException

Throws:

WebValidationException

deleteProject

@DELETE
@Path("{projectKey : ([^-/]+)}")
public jakarta.ws.rs.core.Response deleteProject(@PathParam("projectKey")
 String projectKey)
                                          throws NotFoundException,
NotAuthorizedException

Throws:

NotFoundException

NotAuthorizedException

createProject

@POST
public jakarta.ws.rs.core.Response createProject(@Nullable
 @Nullable RestProjectCreate request,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                          throws WebValidationException

Throws:

WebValidationException

getProjectVariables

@GET
@Path("{projectKey : ([^-/]+)}/variables")
public jakarta.ws.rs.core.Response getProjectVariables(@PathParam("projectKey")
 String projectKey)

getProjectVariable

@GET
@Path("{projectKey : ([^-/]+)}/variable/{variableName}")
public jakarta.ws.rs.core.Response getProjectVariable(@PathParam("projectKey")
 String projectKey,
 @PathParam("variableName")
 String variableName)

createOrUpdateVariable

@POST
@Path("{projectKey : ([^-/]+)}/variable")
public jakarta.ws.rs.core.Response createOrUpdateVariable(@PathParam("projectKey")
 String projectKey,
 @Nullable
 @Nullable RestVariable request,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

deleteProjectVariable

@DELETE
@Path("{projectKey : ([^-/]+)}/variable/{variableName}")
public jakarta.ws.rs.core.Response deleteProjectVariable(@PathParam("projectKey")
 String projectKey,
 @PathParam("variableName")
 String variableName)

getPaginatedProjectSharedCredentials

@GET
@Path("/{projectKey : ([^-/]+)}/sharedCredentials")
public RestPageModel<RestSharedCredential> getPaginatedProjectSharedCredentials(@PathParam("projectKey")
 String projectKey,
 @QueryParam("filter") @DefaultValue("")
 String filter,
 @BeanParam
 PageRequest pageRequest,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                                                         throws NotFoundException

Throws:

NotFoundException

deleteProjectSharedCredentials

@DELETE
@Path("/{projectKey : ([^-/]+)}/sharedCredentials/{sharedCredentialId}")
public jakarta.ws.rs.core.Response deleteProjectSharedCredentials(@PathParam("projectKey")
 String projectKey,
 @PathParam("sharedCredentialId")
 long sharedCredentialsId)

exportProjectSpecs

@GET
@Path("{projectKey : ([^-/]+)}/specs")
public jakarta.ws.rs.core.Response exportProjectSpecs(@PathParam("projectKey")
 String projectKey,
 @QueryParam("package")
 String packageNameOpt,
 @Nullable @QueryParam("format")
 @Nullable String formatParam)