Package com.atlassian.bamboo.configuration.external.yaml

Interface BambooYamlValidator

All Known Implementing Classes:

BambooYamlValidatorImpl

public interface BambooYamlValidator

Validator for simplified Bamboo YAML documents.

Method Summary

Modifier and Type	Method	Description
void	validateDeployment(@NotNull BambooYamlDeploymentDefinition deploymentDefinition, @NotNull List<com.atlassian.bamboo.specs.api.builders.plan.Plan> plansInYaml)	Validates an instance of BambooYamlDeploymentDefinition.
void	validateDeploymentPermissions(@NotNull BambooYamlDeploymentPermissionsDefinition deploymentPermissionsDefinition)	Validates an instance of BambooYamlDeploymentPermissionsDefinition.
void	validatePlan(@NotNull BambooYamlPlanDefinition planDefinition, @NotNull VcsRepositoryData repository)	Validates an instance of BambooYamlPlanDefinition.
void	validatePlanPermissions(@NotNull BambooYamlPlanPermissionsDefinition planPermissionsDefinition)	Validates an instance of BambooYamlPlanPermissionsDefinition.

Method Details

validatePlan

void validatePlan(@NotNull
 @NotNull BambooYamlPlanDefinition planDefinition,
 @NotNull
 @NotNull VcsRepositoryData repository)

Validates an instance of BambooYamlPlanDefinition.

Parameters:

planDefinition - YAML document to validate

repository - repository string the YAML document

Throws:

YamlSpecsValidationException - if the passed YAML document is invalid in any way

validatePlanPermissions

void validatePlanPermissions(@NotNull
 @NotNull BambooYamlPlanPermissionsDefinition planPermissionsDefinition)

Validates an instance of BambooYamlPlanPermissionsDefinition.

Parameters:

planPermissionsDefinition - YAML document to validate

Throws:

YamlSpecsValidationException - if the passed YAML document is invalid in any way

validateDeployment

void validateDeployment(@NotNull
 @NotNull BambooYamlDeploymentDefinition deploymentDefinition,
 @NotNull
 @NotNull List<com.atlassian.bamboo.specs.api.builders.plan.Plan> plansInYaml)

Validates an instance of BambooYamlDeploymentDefinition.

Parameters:

deploymentDefinition - YAML document to validate

plansInYaml - plans which should be created from yaml file

Throws:

YamlSpecsValidationException - if the passed YAML document is invalid in any way

validateDeploymentPermissions

void validateDeploymentPermissions(@NotNull
 @NotNull BambooYamlDeploymentPermissionsDefinition deploymentPermissionsDefinition)

Validates an instance of BambooYamlDeploymentPermissionsDefinition.

Parameters:

deploymentPermissionsDefinition - YAML document to validate

Throws:

YamlSpecsValidationException - if the passed YAML document is invalid in any way