com.atlassian.bamboo.v2.build

Interface ImportExportAwarePlugin<T extends com.atlassian.bamboo.specs.api.builders.plan.configuration.PluginConfiguration<P>,P extends com.atlassian.bamboo.specs.api.model.plan.configuration.PluginConfigurationProperties>

All Superinterfaces:

BambooPluginModule, BuildConfigurationAwarePlugin, InitablePluginModule, RenderableBuildConfiguration

All Known Implementing Classes:

ConcurrentBuildsPlanConfigurationPlugin

public interface ImportExportAwarePlugin<T extends com.atlassian.bamboo.specs.api.builders.plan.configuration.PluginConfiguration<P>,P extends com.atlassian.bamboo.specs.api.model.plan.configuration.PluginConfigurationProperties>
extends BuildConfigurationAwarePlugin

Interface for plugin modules that support importing and exporting of their configuration.

Method Summary

Modifier and Type	Method and Description
void	addToBuildConfiguration(P specsProperties, org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration) Validate and add data from specs properties to passed build configuration.
default T	fromYaml(Node node) Import configuration of this plugin from YAML node to Bamboo Specs entity.
Set<String>	getConfigurationKeys() Return all property keys related to this plugin module which may exist in a plan's BuildConfiguration.
T	toSpecsEntity(org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration) Export configuration of this plugin to Bamboo Specs entity.
default Node	toYaml(P specsProperties) Convert configuration of this plugin from Bamboo Specs to YAML structure.

Methods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin

addDefaultValues, isConfigurationMissing, prepareConfigObject, validate

Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule

init

Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration

getEditHtml, getViewHtml

Method Detail

getConfigurationKeys

@NotNull
Set<String> getConfigurationKeys()

Return all property keys related to this plugin module which may exist in a plan's BuildConfiguration.

The returned set may be immutable. If a plugin module doesn't have configuration, then an empty set should be returned.

toSpecsEntity

@NotNull
T toSpecsEntity(@NotNull
                         org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration)

Export configuration of this plugin to Bamboo Specs entity.

addToBuildConfiguration

void addToBuildConfiguration(@NotNull
                             P specsProperties,
                             @NotNull
                             org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration)

Validate and add data from specs properties to passed build configuration.

Parameters:

specsProperties -

buildConfiguration -

fromYaml

@Nullable
default T fromYaml(Node node)
                      throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Import configuration of this plugin from YAML node to Bamboo Specs entity.

Parameters:

node - yaml node

Returns:

Bamboo Specs entity for plugin settings.

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException - if configuration is wrong.

toYaml

@Nullable
default Node toYaml(@NotNull
                              P specsProperties)

Convert configuration of this plugin from Bamboo Specs to YAML structure.

Returns:

YAML Node containing representation of Bamboo Specs entity.