com.atlassian.bamboo.configuration.external

Class PlanConfigImportServiceImpl

java.lang.Object

com.atlassian.bamboo.configuration.external.PlanConfigImportServiceImpl

All Implemented Interfaces:

PlanConfigImportService

public class PlanConfigImportServiceImpl
extends Object
implements PlanConfigImportService

Constructor Summary

Constructors

Constructor and Description
PlanConfigImportServiceImpl()

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.
TopLevelPlan	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanConfigImportServiceImpl

public PlanConfigImportServiceImpl()

Method Detail

convertYamlToPlan

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

Description copied from interface: PlanConfigImportService

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).

Specified by:

convertYamlToPlan in interface PlanConfigImportService

Parameters:

yaml - YAML String containing definition of top level plan

Returns:

top level plan properties after contextless validation

Throws:

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

YamlValidationException - if the format of the YAML file is invalid

importPlan

@NotNull
public TopLevelPlan 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

Description copied from interface: PlanConfigImportService

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

Specified by:

importPlan in interface PlanConfigImportService

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