com.atlassian.bamboo.plugins.rest.plan

Class PlanConfigResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.plan.PlanConfigResource

@ExperimentalApi
public class PlanConfigResource
extends Object

Provides RESTful operations for the configuration of build plans.

Since:

5.9

Field Summary

Fields

Modifier and Type	Field and Description
static RestPageModel<RestJob>	ALL_JOBS
static RestPlanConfig	PLAN_CONFIG Used for REST documentation generation.

Constructor Summary

Constructors

Constructor and Description
PlanConfigResource(PlanService planService, JobService jobService, InputParser inputParser, PaginationService paginationService, PlanConversionFunction planConversionFunction, JobConversionFunction jobConversionFunction)

Method Summary

Modifier and Type	Method and Description
RestPageModel<RestJob>	getJobsForPlan(String planKeyString, Expansion expansion, PageRequest pageRequest, javax.ws.rs.core.UriInfo uriInfo) Retrieves all jobs for a build plan.
RestPlanConfig	getPlan(String planKeyString, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Gets the details of a build plan configuration.

Methods inherited from class java.lang.Object

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

Field Detail

PLAN_CONFIG

public static final RestPlanConfig PLAN_CONFIG

Used for REST documentation generation.

ALL_JOBS

public static final RestPageModel<RestJob> ALL_JOBS

Constructor Detail

PlanConfigResource

public PlanConfigResource(PlanService planService,
                          JobService jobService,
                          InputParser inputParser,
                          PaginationService paginationService,
                          PlanConversionFunction planConversionFunction,
                          JobConversionFunction jobConversionFunction)

Method Detail

getPlan

public RestPlanConfig getPlan(String planKeyString,
                              @Context
                              Expansion expansion,
                              @Context
                              javax.ws.rs.core.UriInfo uriInfo)
                       throws WebValidationException

Gets the details of a build plan configuration.

Parameters:

planKeyString - key of the build plan to get the configuration for

expansion - represents an expansion tree of additional information we want to retrieve

Returns:

RestPlan a representation of the configuration of a build plan

Throws:

WebValidationException

getJobsForPlan

public RestPageModel<RestJob> getJobsForPlan(String planKeyString,
                                             @Context
                                             Expansion expansion,
                                             @Context
                                             PageRequest pageRequest,
                                             @Context
                                             javax.ws.rs.core.UriInfo uriInfo)

Retrieves all jobs for a build plan.

Parameters:

planKeyString - key of the plan to retrieve jobs for

expansion - represents an expansion tree of additional information we want to retrieve

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

uriInfo - provides access to application and request URI information

Returns:

a paginated representation of a RestJob