com.atlassian.bamboo.configuration.external.yaml

Class BambooYamlParserImpl

java.lang.Object

com.atlassian.bamboo.configuration.external.yaml.BambooYamlParserImpl

All Implemented Interfaces:

BambooYamlParser

public class BambooYamlParserImpl
extends Object
implements BambooYamlParser

Constructor Summary

Constructors

Constructor and Description
BambooYamlParserImpl(BambooYamlVersion1Converter bambooYamlVersion1Converter, BambooYamlOverrider bambooYamlOverrider, I18nBeanFactory i18nBeanFactory, com.atlassian.plugin.PluginAccessor pluginAccessor, TaskManager taskManager)

Method Summary

Modifier and Type	Method and Description
static BranchManagementConfiguration	getDefaultBranchManagementSettings() Values should be synchronized with com.atlassian.bamboo.configuration.external.yaml.YamlV1ToSpecs#getDefaultPlanBranchManagement().
BambooYamlDeploymentDefinition	parseDeployment(Map<String,Object> structure, BambooYamlVersion yamlVersion, VcsRepositoryData repository) Constructs an instance of BambooYamlDeploymentDefinition based on the given YAML structure.
BambooYamlDeploymentPermissionsDefinition	parseDeploymentPermissions(Map<String,Object> structure, BambooYamlVersion yamlVersion) Constructs an instance of BambooYamlDeploymentPermissionsDefinition based on the given YAML structure.
BambooYamlPlanDefinition	parsePlan(Map<String,Object> rawYamlStructure, BambooYamlVersion yamlVersion, VcsRepositoryData repository, RssExecutionOutputHandler stdout) Constructs an instance of BambooYamlPlanDefinition based on the given YAML structure.
BambooYamlPlanPermissionsDefinition	parsePlanPermissions(Map<String,Object> structure, BambooYamlVersion yamlVersion) Constructs an instance of BambooYamlPlanPermissionsDefinition based on the given YAML structure.

Methods inherited from class java.lang.Object

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

Constructor Detail

BambooYamlParserImpl

@Inject
public BambooYamlParserImpl(BambooYamlVersion1Converter bambooYamlVersion1Converter,
                                    BambooYamlOverrider bambooYamlOverrider,
                                    I18nBeanFactory i18nBeanFactory,
                                    com.atlassian.plugin.PluginAccessor pluginAccessor,
                                    TaskManager taskManager)

Method Detail

parsePlan

@NotNull
public BambooYamlPlanDefinition parsePlan(@NotNull
                                                   Map<String,Object> rawYamlStructure,
                                                   @NotNull
                                                   BambooYamlVersion yamlVersion,
                                                   @NotNull
                                                   VcsRepositoryData repository,
                                                   @NotNull
                                                   RssExecutionOutputHandler stdout)

Description copied from interface: BambooYamlParser

Constructs an instance of BambooYamlPlanDefinition based on the given YAML structure. This method will run basic validation, e.g. that types in the YAML document match.

Specified by:

parsePlan in interface BambooYamlParser

Parameters:

rawYamlStructure - a single YAML document converted into a Map

yamlVersion - YAML format version

repository - the VCS where the YAML is from

stdout - output handler for logging execution information

Returns:

parsed plan properties defined in the document

getDefaultBranchManagementSettings

@NotNull
public static BranchManagementConfiguration getDefaultBranchManagementSettings()

Values should be synchronized with com.atlassian.bamboo.configuration.external.yaml.YamlV1ToSpecs#getDefaultPlanBranchManagement().

parseDeployment

@NotNull
public BambooYamlDeploymentDefinition parseDeployment(@NotNull
                                                               Map<String,Object> structure,
                                                               @NotNull
                                                               BambooYamlVersion yamlVersion,
                                                               @NotNull
                                                               VcsRepositoryData repository)

Description copied from interface: BambooYamlParser

Constructs an instance of BambooYamlDeploymentDefinition based on the given YAML structure. This method will run basic validation, e.g. that types in the YAML document match.

Specified by:

parseDeployment in interface BambooYamlParser

Parameters:

structure - a single YAML document converted into a Map

yamlVersion - YAML format version

Returns:

parsed deployment project properties defined in the document

parseDeploymentPermissions

@NotNull
public BambooYamlDeploymentPermissionsDefinition parseDeploymentPermissions(Map<String,Object> structure,
                                                                                     BambooYamlVersion yamlVersion)

Description copied from interface: BambooYamlParser

Constructs an instance of BambooYamlDeploymentPermissionsDefinition based on the given YAML structure. This method will run basic validation, e.g. that types in the YAML document match.

Specified by:

parseDeploymentPermissions in interface BambooYamlParser

Parameters:

structure - a single YAML document converted into a Map

yamlVersion - YAML format version

Returns:

parsed deployment project permissions properties defined in the document

parsePlanPermissions

@NotNull
public BambooYamlPlanPermissionsDefinition parsePlanPermissions(Map<String,Object> structure,
                                                                         BambooYamlVersion yamlVersion)
                                                                  throws YamlSpecsValidationException

Description copied from interface: BambooYamlParser

Constructs an instance of BambooYamlPlanPermissionsDefinition based on the given YAML structure. This method will run basic validation, e.g. that types in the YAML document match.

Specified by:

parsePlanPermissions in interface BambooYamlParser

Parameters:

structure - a single YAML document converted into a Map

yamlVersion - YAML format version

Returns:

parsed plan permissions properties defined in the document

Throws:

YamlSpecsValidationException - if the passed YAML document is not a valid plan permissions definition