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

Class BambooPlanConfigImportResource

java.lang.Object

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

@Singleton
public class BambooPlanConfigImportResource
extends Object

Constructor Summary

Constructors

Constructor and Description
BambooPlanConfigImportResource(com.atlassian.event.api.EventPublisher eventPublisher, com.atlassian.sal.api.message.I18nResolver i18nResolver, BambooAuthenticationContext authenticationContext, PlanConfigImportService planConfigImportService, PlanPermissionService planPermissionService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	importBranch(String yamlString, String branch, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	importPlan(String yamlString, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Import configuration of a top level plan in YAML format.
javax.ws.rs.core.Response	importPlanPermission(String yaml, javax.ws.rs.core.HttpHeaders headers) Import configuration of plan permission in YAML format.

Methods inherited from class java.lang.Object

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

Constructor Detail

BambooPlanConfigImportResource

public BambooPlanConfigImportResource(com.atlassian.event.api.EventPublisher eventPublisher,
                                      com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                      BambooAuthenticationContext authenticationContext,
                                      PlanConfigImportService planConfigImportService,
                                      PlanPermissionService planPermissionService)

Method Detail

importPlan

public javax.ws.rs.core.Response importPlan(@NotNull
                                            String yamlString,
                                            @Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @Context
                                            javax.ws.rs.core.UriInfo uriInfo)
                                     throws WebValidationException

Import configuration of a top level plan in YAML format.

A minimal valid input consists of plan name, plan key and project reference:

   ---
   key: PLAN
   name: My Plan
   project:
     key: PROJ
   ...
 

Throws:

WebValidationException

importPlanPermission

public javax.ws.rs.core.Response importPlanPermission(@NotNull
                                                      String yaml,
                                                      @Context
                                                      javax.ws.rs.core.HttpHeaders headers)
                                               throws WebValidationException

Import configuration of plan permission in YAML format.

Throws:

WebValidationException

importBranch

public javax.ws.rs.core.Response importBranch(@NotNull
                                              String yamlString,
                                              String branch,
                                              @Context
                                              javax.ws.rs.core.HttpHeaders headers,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)
                                       throws WebValidationException

Throws:

WebValidationException