com.atlassian.bamboo.configuration.external.exporters

Interface RepositoryExporter

All Known Implementing Classes:

RepositoryExporterImpl

public interface RepositoryExporter

Service to export Bamboo vcs repository definitions to YAML config files.

Since:

5.11

Method Summary

Modifier and Type	Method and Description
default PartialVcsRepositoryData	importRepository(com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryProperties repositoryProperties, VcsRepositoryData existingData, boolean global) Transform repository properties to format used by Bamboo services.
PartialVcsRepositoryData	importRepository(com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryProperties repositoryProperties, VcsRepositoryData existingData, boolean global, com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryBranchProperties branchOverride) Transform repository properties to format used by Bamboo services.
com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryProperties	toEntityProperties(String yaml) Generate VcsRepositoryProperties from YAML string
com.atlassian.bamboo.specs.api.builders.repository.VcsRepository	toSpecsEntity(PartialVcsRepositoryData repositoryData)
<T extends com.atlassian.bamboo.specs.api.builders.repository.VcsRepository<T,E>,E extends com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryProperties> T	toSpecsEntity(VcsRepositoryData repositoryData)
Pair<com.atlassian.bamboo.specs.api.builders.repository.VcsRepository,com.atlassian.bamboo.specs.api.builders.repository.VcsRepositoryBranch>	toSpecsEntityAndBranchOverride(PartialVcsRepositoryData repositoryData) Export repository to pair of repository specs objects and (optionally) branch override object.

Method Detail

toEntityProperties

@NotNull
com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryProperties toEntityProperties(@NotNull
                                                                                                    String yaml)
                                                                                             throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException,
                                                                                                    YamlValidationException

Generate VcsRepositoryProperties from YAML string

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

YamlValidationException

Since:

6.0

toSpecsEntity

@NotNull
com.atlassian.bamboo.specs.api.builders.repository.VcsRepository toSpecsEntity(@NotNull
                                                                                        PartialVcsRepositoryData repositoryData)

Parameters:

repositoryData -

Returns:

Since:

6.0

toSpecsEntityAndBranchOverride

@NotNull
Pair<com.atlassian.bamboo.specs.api.builders.repository.VcsRepository,com.atlassian.bamboo.specs.api.builders.repository.VcsRepositoryBranch> toSpecsEntityAndBranchOverride(@NotNull
                                                                                                                                                                                      PartialVcsRepositoryData repositoryData)

Export repository to pair of repository specs objects and (optionally) branch override object. This method can be used to generate more readable code when the branch is the only thing that repository overrides compared to its parent.

Since:

6.10

toSpecsEntity

@NotNull
<T extends com.atlassian.bamboo.specs.api.builders.repository.VcsRepository<T,E>,E extends com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryProperties> T toSpecsEntity(@NotNull
                                                                                                                                                                                             VcsRepositoryData repositoryData)

Parameters:

repositoryData -

Returns:

Since:

6.0

importRepository

@NotNull
default PartialVcsRepositoryData importRepository(@NotNull
                                                           com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryProperties repositoryProperties,
                                                           @Nullable
                                                           VcsRepositoryData existingData,
                                                           boolean global)
                                                    throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException,
                                                           YamlValidationException

Transform repository properties to format used by Bamboo services. Will retrieve parent repository if needed, but will not save anything to database.

Parameters:

repositoryProperties - configuration of repository

existingData - previously existing repository data

global - is repository global

Returns:

repository data

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException - if data validation fails

YamlValidationException - if the format of the data is invalid - only discoverable at this stage because pluggable code is involved in validation

importRepository

@NotNull
PartialVcsRepositoryData importRepository(@NotNull
                                                   com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryProperties repositoryProperties,
                                                   @Nullable
                                                   VcsRepositoryData existingData,
                                                   boolean global,
                                                   @Nullable
                                                   com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryBranchProperties branchOverride)
                                            throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException,
                                                   YamlValidationException

Transform repository properties to format used by Bamboo services. Will retrieve parent repository if needed, but will not save anything to database.

Parameters:

repositoryProperties - configuration of repository

existingData - previously existing repository data

global - is repository global

branchOverride - branch to be used.

Returns:

repository data

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException - if data validation fails

YamlValidationException - if the format of the data is invalid - only discoverable at this stage because pluggable code is involved in validation