com.atlassian.bamboo.plugins.rest.build

Class PlanResource

java.lang.Object

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

@Singleton
 @Component
public class PlanResource
extends Object

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

Constructor Summary

Constructors

Constructor and 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, AdministrationConfigurationAccessor administrationConfigurationAccessor, TestQuarantineManager testQuarantineManager, FeatureManager featureManager, VcsRepositoryManager vcsRepositoryManager, DeletionService deletionService, RssDetectionService rssDetectionService, ChainBranchManager chainBranchManager, BuildDefinitionManager buildDefinitionManager, SpecsConsumerFactory specsConsumerFactory, SpecsExporter specsExporter)

Method Summary

Modifier and Type	Method and Description
void	addPlanLabel(String projectKey, String buildKey, RestPlanLabel label, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Adds new label to plan specified by projectKey-buildKey.
RestPlanBranch	createNewBranch(String projectKey, String buildKey, String branchName, String vcsBranchName, Boolean enabled, Boolean cleanupEnabled, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Method for creating branch for a specified plan.
javax.ws.rs.core.Response	deletePlan(String projectKey, String buildKey) Marks plan for deletion.
javax.ws.rs.core.Response	disablePlan(String projectKey, String buildKey) Disable plan.
javax.ws.rs.core.Response	enablePlan(String projectKey, String buildKey) Enable plan.
javax.ws.rs.core.Response	enableSpecsForBranches(String projectKey, String buildKey) Enable specs scanning for all branches.
javax.ws.rs.core.Response	exportPlanSpec(String projectKey, String buildKey, String packageNameOpt, String formatParam) Export plan as Bamboo Specs code.
RestPlans	getAllPlanList(javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Method used to list all plans on Bamboo service that user is allowed to see (READ permission).
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, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Possible expand parameters: actions, stages, branches, variableContext.
RestPlan	getPlanAlias(String projectKey, String buildKey, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Possible expand parameters: actions, stages, branches, variableContext.
RestArtifactDefinitions	getPlanArtifactDefinition(String projectKey, String buildKey, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
javax.ws.rs.core.Response	getPlanBranch(String projectKey, String buildKey, String branchName, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide details for specified Branch of a specified Plan.
RestBranches	getPlanBranches(String projectKey, String buildKey, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide list of branches for specified plan.
RestPlanLabels	getPlanLabels(String projectKey, String buildKey, javax.ws.rs.core.UriInfo uriInfo) Provide list of labels for plan specified by projectKey-buildKey.
RestVcsBranches	getVcsBranches(String projectKey, String buildKey, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders hh) Provide list of vcs branch names for branches that exist on the default repository of this plan
javax.ws.rs.core.Response	markPlanFavourite(String projectKey, String buildKey, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
javax.ws.rs.core.Response	quarantineTest(String projectKey, String buildKey, long testId, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext, RestQuarantineExpiry restQuarantineExpiry)
javax.ws.rs.core.Response	removePlanLabel(String projectKey, String buildKey, String labelName, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Removes label from plan specified by projectKey-buildKey-buildNumber.
javax.ws.rs.core.Response	unleashTest(String projectKey, String buildKey, long testId, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
javax.ws.rs.core.Response	unmarkPlanFavourite(String projectKey, String buildKey, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Remove plan from favorites.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanResource

@Autowired
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,
                               AdministrationConfigurationAccessor administrationConfigurationAccessor,
                               TestQuarantineManager testQuarantineManager,
                               FeatureManager featureManager,
                               VcsRepositoryManager vcsRepositoryManager,
                               DeletionService deletionService,
                               RssDetectionService rssDetectionService,
                               ChainBranchManager chainBranchManager,
                               BuildDefinitionManager buildDefinitionManager,
                               SpecsConsumerFactory specsConsumerFactory,
                               SpecsExporter specsExporter)

Method Detail

getAllPlanList

public RestPlans getAllPlanList(@Context
                                javax.ws.rs.core.UriInfo uriInfo,
                                @Context
                                com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Method used to list all plans on Bamboo service that user is allowed to see (READ permission). Should be invoked as /rest/api/latest/plan

Possible expand parameters: * plans - list of plans

* plans.plan - list of plans with plan details

* plans.plan.actions

Returns:

list of plans on Bamboo server

getPlan

public RestPlan getPlan(String projectKey,
                        String buildKey,
                        @Context
                        javax.ws.rs.core.UriInfo uriInfo,
                        @Context
                        com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Possible expand parameters: actions, stages, branches, variableContext.

Parameters:

projectKey -

buildKey -

getPlanAlias

public RestPlan getPlanAlias(String projectKey,
                             String buildKey,
                             @Context
                             javax.ws.rs.core.UriInfo uriInfo,
                             @Context
                             com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Possible expand parameters: actions, stages, branches, variableContext.

Parameters:

projectKey -

buildKey -

getPlanBranches

public RestBranches getPlanBranches(String projectKey,
                                    String buildKey,
                                    @Context
                                    javax.ws.rs.core.UriInfo uriInfo,
                                    @Context
                                    com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide list of branches for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey). You can use "enabledOnly" param to filter out disabled branches.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

Returns:

RestBranches

createNewBranch

public RestPlanBranch createNewBranch(String projectKey,
                                      String buildKey,
                                      String branchName,
                                      String vcsBranchName,
                                      Boolean enabled,
                                      Boolean cleanupEnabled,
                                      @Context
                                      javax.ws.rs.core.UriInfo uriInfo,
                                      @Context
                                      com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
                               throws WebValidationException

Method for creating branch for a specified plan. You can use vcsBranch query param to define which vcsBranch should newly created branch use. If not specified it will not override vcsBranch from the main plan.

Example usage: curl -X PUT --user admin:admin http://localhost:8085/rest/api/latest/plan/PROJ-PLAN/branch/BranchName?vcsBranch="/refs/heads/myBranch"

Parameters:

projectKey - project key

buildKey - plan key

branchName - new branch name

vcsBranchName - name of the VCS branch

enabled -

cleanupEnabled - enable branch expiry

Returns:

RestPlanBranch the newly created branch

Throws:

WebValidationException - if there's validation errors, which maps into a 400 Bad Request

getPlanBranch

public javax.ws.rs.core.Response getPlanBranch(String projectKey,
                                               String buildKey,
                                               String branchName,
                                               @Context
                                               javax.ws.rs.core.UriInfo uriInfo,
                                               @Context
                                               com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide details for specified Branch of a specified Plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

branchName - branch display name

Returns:

RestBranches

getPlanLabels

public RestPlanLabels getPlanLabels(String projectKey,
                                    String buildKey,
                                    @Context
                                    javax.ws.rs.core.UriInfo uriInfo)

Provide list of labels for plan specified by projectKey-buildKey.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

Returns:

RestPlanLabels

addPlanLabel

public void addPlanLabel(String projectKey,
                         String buildKey,
                         RestPlanLabel label,
                         @Context
                         com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Adds new label to plan specified by projectKey-buildKey.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

label - label content to add to build result

removePlanLabel

public javax.ws.rs.core.Response removePlanLabel(String projectKey,
                                                 String buildKey,
                                                 String labelName,
                                                 @Context
                                                 com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
                                          throws Exception

Removes label from plan specified by projectKey-buildKey-buildNumber.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

labelName - label name to remove from plan

Throws:

Exception

getVcsBranches

public RestVcsBranches getVcsBranches(String projectKey,
                                      String buildKey,
                                      @Context
                                      javax.ws.rs.core.UriInfo uriInfo,
                                      @Context
                                      javax.ws.rs.core.HttpHeaders hh)

Provide list of vcs branch names for branches that exist on the default repository of this plan

Parameters:

projectKey - project key

buildKey - plan key - only top level plans are supported

Returns:

RestVcsBranchList

getIssueDetails

public RestJiraIssue getIssueDetails(String projectKey,
                                     String buildKey,
                                     String issueKey,
                                     @Context
                                     javax.ws.rs.core.UriInfo uriInfo)

markPlanFavourite

public javax.ws.rs.core.Response markPlanFavourite(String projectKey,
                                                   String buildKey,
                                                   @Context
                                                   com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

unmarkPlanFavourite

public javax.ws.rs.core.Response unmarkPlanFavourite(String projectKey,
                                                     String buildKey,
                                                     @Context
                                                     com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Remove plan from favorites.

Parameters:

projectKey -

buildKey -

Returns:

204 HTTP status when plan was removed from favourites.

enablePlan

public javax.ws.rs.core.Response enablePlan(String projectKey,
                                            String buildKey)

Enable plan.

Parameters:

projectKey -

buildKey -

Returns:

204 HTTP status when plan was enabled.

disablePlan

public javax.ws.rs.core.Response disablePlan(String projectKey,
                                             String buildKey)

Disable plan.

Parameters:

projectKey -

buildKey -

Returns:

204 HTTP status when plan was disabled

deletePlan

public javax.ws.rs.core.Response deletePlan(String projectKey,
                                            String buildKey)

Marks plan for deletion. Plan will be deleted by a batch job.

Parameters:

projectKey -

buildKey -

Returns:

204 HTTP status when plan was deleted

getPlanArtifactDefinition

public RestArtifactDefinitions getPlanArtifactDefinition(String projectKey,
                                                         String buildKey,
                                                         @Context
                                                         javax.ws.rs.core.UriInfo uriInfo,
                                                         @Context
                                                         com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

quarantineTest

public javax.ws.rs.core.Response quarantineTest(String projectKey,
                                                String buildKey,
                                                long testId,
                                                @Context
                                                com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext,
                                                @NotNull
                                                RestQuarantineExpiry restQuarantineExpiry)
                                         throws WebValidationException

Throws:

WebValidationException

unleashTest

public javax.ws.rs.core.Response unleashTest(String projectKey,
                                             String buildKey,
                                             long testId,
                                             @Context
                                             com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
                                      throws WebValidationException

Throws:

WebValidationException

enableSpecsForBranches

public javax.ws.rs.core.Response enableSpecsForBranches(String projectKey,
                                                        String buildKey)

Enable specs scanning for all branches.

exportPlanSpec

public javax.ws.rs.core.Response exportPlanSpec(String projectKey,
                                                String buildKey,
                                                String packageNameOpt,
                                                @Nullable
                                                String formatParam)
                                         throws WebValidationException

Export plan as Bamboo Specs code.

Parameters:

projectKey - The project to export from

buildKey - The specific build to export

packageNameOpt - Optionally, a package name for the exported spec

formatParam - Optionally, a format of code. It's SpecsExporter.ExportFormat#JAVA by default. Other option is SpecsExporter.ExportFormat#YAML.

Returns:

200 when the export was successful

Throws:

WebValidationException - If generating the spec fails.