Package com.atlassian.bamboo.plugins.rest.configuration.external

Class BambooPlanConfigExportResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.configuration.external.BambooPlanConfigExportResource

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

Constructor Summary

Constructors

Constructor	Description
BambooPlanConfigExportResource(PlanConfigExportService planConfigExportService, CachedPlanManager cachedPlanManager, BambooPermissionManager bambooPermissionManager, com.atlassian.event.api.EventPublisher eventPublisher, com.atlassian.sal.api.message.I18nResolver i18nResolver, FeatureManager featureManager)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	exportAllPlans()	Export configuration of all top level plans, linked repositories and shared credentials to YAML format.
javax.ws.rs.core.Response	exportPlan(String projectKey, String planKey)	Export configuration of a top level plan to YAML format
javax.ws.rs.core.Response	exportPlanAlias(String projectKey, String planKey)	Export configuration of a top level plan to YAML format

Methods inherited from class java.lang.Object

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

Constructor Details

BambooPlanConfigExportResource

@Inject
public BambooPlanConfigExportResource(PlanConfigExportService planConfigExportService,
 CachedPlanManager cachedPlanManager,
 BambooPermissionManager bambooPermissionManager,
 com.atlassian.event.api.EventPublisher eventPublisher,
 com.atlassian.sal.api.message.I18nResolver i18nResolver,
 FeatureManager featureManager)

Method Details

exportAllPlans

@POST
@Path("all")
public javax.ws.rs.core.Response exportAllPlans()

Export configuration of all top level plans, linked repositories and shared credentials to YAML format.

Returns:

json array of paths to all updated files

exportPlan

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

Export configuration of a top level plan to YAML format

Parameters:

projectKey - project key

planKey -

Returns:

json array of paths to all updated files

exportPlanAlias

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

Export configuration of a top level plan to YAML format

Parameters:

projectKey - project key

planKey -

Returns:

json array of paths to all updated files