com.atlassian.bamboo.configuration.external.yaml

Interface BambooYamlParser

All Known Implementing Classes:

BambooYamlParserImpl

public interface BambooYamlParser

Parser for simplified Bamboo YAML documents.

See Also:

BambooYamlDefinition

Method Summary

Modifier and Type	Method and Description
@NotNull BambooYamlDeploymentDefinition	parseDeployment(@NotNull Map<String,Object> yamlStructure, @NotNull BambooYamlVersion yamlVersion, @NotNull VcsRepositoryData repository) Constructs an instance of BambooYamlDeploymentDefinition based on the given YAML structure.
@NotNull BambooYamlDeploymentPermissionsDefinition	parseDeploymentPermissions(Map<String,Object> yamlStructure, BambooYamlVersion yamlVersion) Constructs an instance of BambooYamlDeploymentPermissionsDefinition based on the given YAML structure.
@NotNull BambooYamlPlanDefinition	parsePlan(@NotNull Map<String,Object> yamlStructure, @NotNull BambooYamlVersion yamlVersion, @NotNull VcsRepositoryData repository, @NotNull RssExecutionOutputHandler stdout) Constructs an instance of BambooYamlPlanDefinition based on the given YAML structure.
@NotNull BambooYamlPlanPermissionsDefinition	parsePlanPermissions(Map<String,Object> yamlStructure, BambooYamlVersion yamlVersion) Constructs an instance of BambooYamlPlanPermissionsDefinition based on the given YAML structure.

Method Detail

parsePlan

@NotNull
@NotNull BambooYamlPlanDefinition parsePlan(@NotNull
                                                     @NotNull Map<String,Object> yamlStructure,
                                                     @NotNull
                                                     @NotNull BambooYamlVersion yamlVersion,
                                                     @NotNull
                                                     @NotNull VcsRepositoryData repository,
                                                     @NotNull
                                                     @NotNull RssExecutionOutputHandler stdout)
                                              throws YamlSpecsValidationException

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.

Parameters:

yamlStructure - 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

Throws:

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

parseDeployment

@NotNull
@NotNull BambooYamlDeploymentDefinition parseDeployment(@NotNull
                                                                 @NotNull Map<String,Object> yamlStructure,
                                                                 @NotNull
                                                                 @NotNull BambooYamlVersion yamlVersion,
                                                                 @NotNull
                                                                 @NotNull VcsRepositoryData repository)
                                                          throws YamlSpecsValidationException

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.

Parameters:

yamlStructure - a single YAML document converted into a Map

yamlVersion - YAML format version

Returns:

parsed deployment project properties defined in the document

Throws:

YamlSpecsValidationException - if the passed YAML document is not a valid deployment project definition

parseDeploymentPermissions

@NotNull
@NotNull BambooYamlDeploymentPermissionsDefinition parseDeploymentPermissions(Map<String,Object> yamlStructure,
                                                                                       BambooYamlVersion yamlVersion)
                                                                                throws YamlSpecsValidationException

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.

Parameters:

yamlStructure - a single YAML document converted into a Map

yamlVersion - YAML format version

Returns:

parsed deployment project permissions properties defined in the document

Throws:

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

parsePlanPermissions

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

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.

Parameters:

yamlStructure - 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