Package com.atlassian.bamboo.configuration.external.rss

Interface YamlSpecsImportService

All Known Implementing Classes:

YamlSpecsImportServiceImpl

public interface YamlSpecsImportService

Service for importing configuration from Yaml Specs

Method Summary

Modifier and Type	Method	Description
boolean	processSimplifiedYaml(SpecsConsumer specsConsumer, VcsRepositoryData repository, VcsBambooSpecsSource specsSource, Path yamlFile, Path workingDir, RssPermissions rssPermissions, List<CommitContext> commits, RssExecutionOutputHandler stdout, String logFilename)	Import configuration from Yaml Specs
void	validateYaml(@NotNull String yaml, @NotNull VcsRepositoryData repository)	Validate Bamboo Yaml Specs.

Method Details

processSimplifiedYaml

boolean processSimplifiedYaml(SpecsConsumer specsConsumer,
 VcsRepositoryData repository,
 VcsBambooSpecsSource specsSource,
 Path yamlFile,
 Path workingDir,
 RssPermissions rssPermissions,
 List<CommitContext> commits,
 RssExecutionOutputHandler stdout,
 String logFilename)
                       throws IOException

Import configuration from Yaml Specs

Parameters:

specsConsumer - consumer used to import configuration from Yaml Specs

repository - repository from which specs have been checked out

specsSource - specs state for current execution

yamlFile - YAML file which contain root documents of Yaml Specs

workingDir - repository working directory

rssPermissions - rss permissions for repository

commits - a list of commits related to Bamboo Specs, which occurred since last execution

stdout - output handler for logging execution information

logFilename - name of the log file

Returns:

true if Specs have been successfully imported, false otherwise

Throws:

IOException

validateYaml

void validateYaml(@NotNull
 @NotNull String yaml,
 @NotNull
 @NotNull VcsRepositoryData repository)
           throws YamlSpecsValidationException

Validate Bamboo Yaml Specs. If successful methods returns nothing, otherwise the is thrown.

Parameters:

yaml - yaml specs represented as a plain string

repository - repository associated with given specs

Throws:

YamlSpecsValidationException

Since:

9.1