Package com.atlassian.bamboo.plugins.rest.build

Class PlanResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.build.PlanResource

@Path("plan")
@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
@Singleton
@Component
public class PlanResource
extends Object

Plan service is supposed to be used to retrieve full list of plans and plan details

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PASSWORD_MASK

Constructor Summary

Constructors

Constructor

Description

PlanResource(BambooPermissionManager bambooPermissionManager, BambooUserManager bambooUserManager, BranchCreationFacade branchCreationFacade, CachedPlanManager cachedPlanManager, PlanManager planManager, LabelManager labelManager, PlanRestService planRestService, VariableDefinitionManager variableDefinitionManager, JiraIssueManager jiraIssueManager, JiraApplinksService jiraApplinksService, com.atlassian.event.api.EventPublisher eventPublisher, ArtifactDefinitionManager artifactDefinitionManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, TestsManager testsManager, TestQuarantineManager testQuarantineManager, VcsRepositoryManager vcsRepositoryManager, DeletionService deletionService, RssDetectionService rssDetectionService, ChainBranchManager chainBranchManager, BuildDefinitionManager buildDefinitionManager, SpecsConsumerFactory specsConsumerFactory, SpecsExporter specsExporter, RestAuthenticationContext restAuthenticationContext)

Method Summary

Modifier and Type	Method	Description
void	addPlanLabel(String projectKey, String buildKey, RestPlanLabel label)
javax.ws.rs.core.Response	addPlanVariable(String projectKey, String buildKey, RestVariable variable, javax.ws.rs.core.UriInfo uriInfo)
RestPlanBranch	createNewBranch(String projectKey, String buildKey, String branchName, String vcsBranchName, Boolean enabled, Boolean cleanupEnabled, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	deletePlan(String projectKey, String buildKey)
javax.ws.rs.core.Response	deletePlanVariable(String projectKey, String buildKey, String variableName)
javax.ws.rs.core.Response	disablePlan(String projectKey, String buildKey)
javax.ws.rs.core.Response	editPlanVariable(String projectKey, String buildKey, String variableName, RestVariable variable)
javax.ws.rs.core.Response	enablePlan(String projectKey, String buildKey)
javax.ws.rs.core.Response	enableSpecsForBranches(String projectKey, String buildKey)
javax.ws.rs.core.Response	exportPlanSpec(String projectKey, String buildKey, String packageNameOpt, @Nullable String formatParam)
RestPlans	getAllPlanList(javax.ws.rs.core.UriInfo uriInfo)
RestJiraIssue	getIssueDetails(String projectKey, String buildKey, String issueKey, javax.ws.rs.core.UriInfo uriInfo)
RestPlan	getPlan(String projectKey, String buildKey, javax.ws.rs.core.UriInfo uriInfo)
RestPlan	getPlanAlias(String projectKey, String buildKey, javax.ws.rs.core.UriInfo uriInfo)
RestArtifactDefinitions	getPlanArtifactDefinition(String projectKey, String buildKey, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	getPlanBranch(String projectKey, String buildKey, String branchName, javax.ws.rs.core.UriInfo uriInfo)
RestBranches	getPlanBranches(String projectKey, String buildKey, javax.ws.rs.core.UriInfo uriInfo)
RestPlanLabels	getPlanLabels(String projectKey, String buildKey, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	getPlanVariable(String projectKey, String buildKey, String variableName)
javax.ws.rs.core.Response	getPlanVariables(String projectKey, String buildKey)
RestVcsBranches	getVcsBranches(String projectKey, String buildKey, @Nullable String searchTerm, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	markPlanFavourite(String projectKey, String buildKey)
javax.ws.rs.core.Response	quarantineTest(String projectKey, String buildKey, long testId)
javax.ws.rs.core.Response	removePlanLabel(String projectKey, String buildKey, String labelName)
javax.ws.rs.core.Response	unleashTest(String projectKey, String buildKey, long testId)
javax.ws.rs.core.Response	unmarkPlanFavourite(String projectKey, String buildKey)

Methods inherited from class java.lang.Object

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

Field Details

PASSWORD_MASK

public static final String PASSWORD_MASK

See Also:

• Constant Field Values

Constructor Details

PlanResource

@Inject
public PlanResource(BambooPermissionManager bambooPermissionManager,
 BambooUserManager bambooUserManager,
 BranchCreationFacade branchCreationFacade,
 CachedPlanManager cachedPlanManager,
 PlanManager planManager,
 LabelManager labelManager,
 PlanRestService planRestService,
 VariableDefinitionManager variableDefinitionManager,
 JiraIssueManager jiraIssueManager,
 JiraApplinksService jiraApplinksService,
 com.atlassian.event.api.EventPublisher eventPublisher,
 ArtifactDefinitionManager artifactDefinitionManager,
 com.atlassian.sal.api.message.I18nResolver i18nResolver,
 TestsManager testsManager,
 TestQuarantineManager testQuarantineManager,
 VcsRepositoryManager vcsRepositoryManager,
 DeletionService deletionService,
 RssDetectionService rssDetectionService,
 ChainBranchManager chainBranchManager,
 BuildDefinitionManager buildDefinitionManager,
 SpecsConsumerFactory specsConsumerFactory,
 SpecsExporter specsExporter,
 RestAuthenticationContext restAuthenticationContext)

Method Details

getAllPlanList

@GET
public RestPlans getAllPlanList(@Context
 javax.ws.rs.core.UriInfo uriInfo)

getPlan

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}")
public RestPlan getPlan(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

getPlanAlias

@GET
@Path("{projectKey : ([^-/]+)}/{buildKey}")
public RestPlan getPlanAlias(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

getPlanBranches

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}/branch")
public RestBranches getPlanBranches(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

createNewBranch

@PUT
@Path("{projectKey : ([^-/]+)}-{buildKey}/branch/{branchName}")
public RestPlanBranch createNewBranch(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("branchName")
 String branchName,
 @QueryParam("vcsBranch")
 String vcsBranchName,
 @QueryParam("enabled")
 Boolean enabled,
 @QueryParam("cleanupEnabled")
 Boolean cleanupEnabled,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                               throws WebValidationException

Throws:

WebValidationException

getPlanBranch

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}/branch/{branchName}")
public javax.ws.rs.core.Response getPlanBranch(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("branchName")
 String branchName,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

getPlanLabels

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}/label")
public RestPlanLabels getPlanLabels(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

addPlanLabel

@POST
@Path("{projectKey : ([^-/]+)}-{buildKey}/label")
public void addPlanLabel(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 RestPlanLabel label)

removePlanLabel

@DELETE
@Path("{projectKey : ([^-/]+)}-{buildKey}/label/{labelName}")
public javax.ws.rs.core.Response removePlanLabel(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("labelName")
 String labelName)
                                          throws Exception

Throws:

Exception

getVcsBranches

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}/vcsBranches")
public RestVcsBranches getVcsBranches(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @Nullable @QueryParam("searchTerm")
 @Nullable String searchTerm,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

getIssueDetails

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}/issue/{issueKey}")
public RestJiraIssue getIssueDetails(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("issueKey")
 String issueKey,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                              throws WebValidationException

Throws:

WebValidationException

markPlanFavourite

@POST
@Path("{projectKey : ([^-/]+)}-{buildKey}/favourite")
public javax.ws.rs.core.Response markPlanFavourite(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey)

unmarkPlanFavourite

@DELETE
@Path("{projectKey : ([^-/]+)}-{buildKey}/favourite")
public javax.ws.rs.core.Response unmarkPlanFavourite(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey)

enablePlan

@POST
@Path("{projectKey : ([^-/]+)}-{buildKey}/enable")
public javax.ws.rs.core.Response enablePlan(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey)

disablePlan

@DELETE
@Path("{projectKey : ([^-/]+)}-{buildKey}/enable")
public javax.ws.rs.core.Response disablePlan(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey)

deletePlan

@DELETE
@Path("{projectKey : ([^-/]+)}-{buildKey}")
public javax.ws.rs.core.Response deletePlan(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey)

getPlanVariables

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

getPlanVariable

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}/variables/{variableName}")
public javax.ws.rs.core.Response getPlanVariable(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("variableName")
 String variableName)

addPlanVariable

@POST
@Path("{projectKey : ([^-/]+)}-{buildKey}/variables")
public javax.ws.rs.core.Response addPlanVariable(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 RestVariable variable,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                                          throws WebValidationException

Throws:

WebValidationException

editPlanVariable

@PUT
@Path("{projectKey : ([^-/]+)}-{buildKey}/variables/{variableName}")
public javax.ws.rs.core.Response editPlanVariable(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("variableName")
 String variableName,
 RestVariable variable)
                                           throws WebValidationException

Throws:

WebValidationException

deletePlanVariable

@DELETE
@Path("{projectKey : ([^-/]+)}-{buildKey}/variables/{variableName}")
public javax.ws.rs.core.Response deletePlanVariable(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("variableName")
 String variableName)

getPlanArtifactDefinition

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}/artifact")
public RestArtifactDefinitions getPlanArtifactDefinition(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

quarantineTest

@POST
@Path("{projectKey : ([^-/]+)}-{buildKey}/test/{testId}/quarantine")
public javax.ws.rs.core.Response quarantineTest(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("testId")
 long testId)
                                         throws WebValidationException

Throws:

WebValidationException

unleashTest

@POST
@Path("{projectKey : ([^-/]+)}-{buildKey}/test/{testId}/unleash")
public javax.ws.rs.core.Response unleashTest(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("testId")
 long testId)
                                      throws WebValidationException

Throws:

WebValidationException

enableSpecsForBranches

@POST
@Path("{projectKey : ([^-/]+)}-{buildKey}/branch/enableSpecsForBranches")
public javax.ws.rs.core.Response enableSpecsForBranches(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey)

exportPlanSpec

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

Throws:

WebValidationException