com.atlassian.bamboo.configuration.external

Interface PlanConfigImportService

All Known Implementing Classes:

PlanConfigImportServiceImpl

@ExperimentalApi
public interface PlanConfigImportService

Service to import plan configurations from human readable format.

Since:

5.15

Method Summary

Modifier and Type	Method and Description
com.atlassian.bamboo.specs.api.model.plan.PlanProperties	convertYamlToPlan(String yaml) Converts data from a YAML document to top level plan properties.
ImmutableTopLevelPlan	importPlan(com.atlassian.bamboo.specs.api.model.plan.PlanProperties planProperties, com.atlassian.user.User userForCreation) Validates exported top level plan properties within Bamboo context (e.g.

Method Detail

convertYamlToPlan

@NotNull
com.atlassian.bamboo.specs.api.model.plan.PlanProperties convertYamlToPlan(@NotNull
                                                                                    String yaml)
                                                                             throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException,
                                                                                    YamlValidationException

Converts data from a YAML document to top level plan properties. This method performs validation of YAML types and of the properties without Bamboo context (e.g. no database integrity is verified).

Parameters:

yaml - YAML String containing definition of top level plan

Returns:

top level plan properties after contextless validation

Throws:

YamlValidationException - if the format of the YAML file is invalid

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException - if the imported properties were not valid

importPlan

@NotNull
ImmutableTopLevelPlan importPlan(@NotNull
                                          com.atlassian.bamboo.specs.api.model.plan.PlanProperties planProperties,
                                          @NotNull
                                          com.atlassian.user.User userForCreation)
                                   throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Validates exported top level plan properties within Bamboo context (e.g. verifying database integrity), then imports the data into the database.

Parameters:

planProperties - top level plan properties to import

userForCreation - invoking the import

Returns:

saved top level plan entity

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException - if data validation fails