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

Class PlanResource

java.lang.Object

com.atlassian.bamboo.plugins.testutils.rest.resource.plan.PlanResource

@Path("plan")
@Consumes("application/json")
@Produces("application/json")
@Singleton
public class PlanResource
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlanResource.BackgroundDeletionCompletedEventLogger

Constructor Summary

Constructors

Constructor

Description

PlanResource(ArtifactDefinitionManager artifactDefinitionManager, BambooUserManager bambooUserManager, CachedPlanManager cachedPlanManager, ChainCreationService chainCreationService, DeletionService deletionService, com.atlassian.event.api.EventPublisher eventPublisher, JobCreationService jobCreationService, JobService jobService, LabelManager labelManager, PlanManager planManager, ProjectManager projectManager, RepositoryDefinitionManager repositoryDefinitionManager, RepositoryTestService repositoryTestService, StageService stageService, TaskConfigurationService taskConfigurationService, TriggerConfigurationService triggerConfigurationService, TriggerTypeManager triggerTypeManager, UIConfigSupport uiConfigSupport, VariableConfigurationService variableConfigurationService, RestAuthenticationContext restAuthenticationContext)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	createPlan(RestPlan restPlan, RestAuthenticationContext restAuthenticationContext)	Create plan.
jakarta.ws.rs.core.Response	createPlanVariable(String planKey, String variableKey, String variableValue)
jakarta.ws.rs.core.Response	deleteAllPlans()	Mark all top level plans for deletion.
jakarta.ws.rs.core.Response	deletePlansInProject(String projectKey)	Mark all top level plans belonging to a project for deletion.
jakarta.ws.rs.core.Response	deletePlanVariable(String planKey, String variableKey)
jakarta.ws.rs.core.Response	doesPlanExistAsRecord(String planKey)
Long	findPlanId(String planKey)
List<String>	getPlanLabels(String planKey)
List<RestRepository>	getPlanRepositories(String planKey)
List<RestVariableDefinition>	getPlanVariables(String planKey)
List<RestTrigger>	getTriggers(String planKey)
jakarta.ws.rs.core.Response	runBackgroundDeletion()	Trigger background deletion and wait up to 30s for its completion
List<String>	setPlanLabels(String planKey, List<String> labels)

Methods inherited from class java.lang.Object

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

Constructor Details

PlanResource

@Inject
public PlanResource(ArtifactDefinitionManager artifactDefinitionManager,
 BambooUserManager bambooUserManager,
 CachedPlanManager cachedPlanManager,
 ChainCreationService chainCreationService,
 DeletionService deletionService,
 com.atlassian.event.api.EventPublisher eventPublisher,
 JobCreationService jobCreationService,
 JobService jobService,
 LabelManager labelManager,
 PlanManager planManager,
 ProjectManager projectManager,
 RepositoryDefinitionManager repositoryDefinitionManager,
 RepositoryTestService repositoryTestService,
 StageService stageService,
 TaskConfigurationService taskConfigurationService,
 TriggerConfigurationService triggerConfigurationService,
 TriggerTypeManager triggerTypeManager,
 UIConfigSupport uiConfigSupport,
 VariableConfigurationService variableConfigurationService,
 RestAuthenticationContext restAuthenticationContext)

Method Details

doesPlanExistAsRecord

@HEAD
@Path("record/{planKey}")
public jakarta.ws.rs.core.Response doesPlanExistAsRecord(@PathParam("planKey")
 String planKey)

deleteAllPlans

@DELETE
public jakarta.ws.rs.core.Response deleteAllPlans()

Mark all top level plans for deletion.

deletePlansInProject

@DELETE
@Path("project/{projectKey}")
public jakarta.ws.rs.core.Response deletePlansInProject(@PathParam("projectKey")
 String projectKey)

Mark all top level plans belonging to a project for deletion.

runBackgroundDeletion

@POST
@Path("backgroundDeletion")
public jakarta.ws.rs.core.Response runBackgroundDeletion()

Trigger background deletion and wait up to 30s for its completion

createPlan

@POST
public jakarta.ws.rs.core.Response createPlan(RestPlan restPlan,
 @Context
 RestAuthenticationContext restAuthenticationContext)

Create plan. This method still has some limitations.

getPlanVariables

@GET
@Path("{planKey}/variables")
public List<RestVariableDefinition> getPlanVariables(@PathParam("planKey")
 String planKey)
                                              throws WebValidationException

Throws:

WebValidationException

createPlanVariable

@POST
@Path("{planKey}/variables/{variableKey}")
public jakarta.ws.rs.core.Response createPlanVariable(@PathParam("planKey")
 String planKey,
 @PathParam("variableKey")
 String variableKey,
 String variableValue)
                                               throws WebValidationException

Throws:

WebValidationException

deletePlanVariable

@DELETE
@Path("{planKey}/variables/{variableKey}")
public jakarta.ws.rs.core.Response deletePlanVariable(@PathParam("planKey")
 String planKey,
 @PathParam("variableKey")
 String variableKey)
                                               throws WebValidationException

Throws:

WebValidationException

findPlanId

@GET
@Path("{planKey}/id")
public Long findPlanId(@PathParam("planKey")
 String planKey)

getPlanRepositories

@GET
@Path("{planKey}/repositories")
public List<RestRepository> getPlanRepositories(@PathParam("planKey")
 String planKey)
                                         throws WebValidationException

Throws:

WebValidationException

getPlanLabels

@GET
@Path("{planKey}/labels")
public List<String> getPlanLabels(@PathParam("planKey")
 String planKey)
                           throws WebValidationException

Throws:

WebValidationException

setPlanLabels

@PUT
@Path("{planKey}/labels")
public List<String> setPlanLabels(@PathParam("planKey")
 String planKey,
 List<String> labels)
                           throws WebValidationException

Throws:

WebValidationException

getTriggers

@GET
@Path("{planKey}/triggers")
public List<RestTrigger> getTriggers(@PathParam("planKey")
 String planKey)
                              throws WebValidationException

Throws:

WebValidationException