com.atlassian.bamboo.v2.build

Interface ImportExportAwarePlugin

All Superinterfaces:

BambooPluginModule, BuildConfigurationAwarePlugin, InitablePluginModule, RenderableBuildConfiguration

All Known Implementing Classes:

ArtifactHandlerForPlanConfigurator, AutomaticDependencyManagementPlugin, BuildExpiryPerPlanPlugin, BuildLabeller, BuildMonitoringPerPlanPlugin, CloverBuildProcessor, ConcurrentBuildsPlanConfigurationPlugin

public interface ImportExportAwarePlugin
extends BuildConfigurationAwarePlugin

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

Method Summary

Modifier and Type	Method and Description
Set<String>	getConfigurationKeys() Return all property keys related to this plugin module which may exist in a plan's BuildConfiguration.
default Map<String,Object>	toSerializableMap(org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration) Convert the given build configuration to a map that can be serialized and then exported by Bamboo.

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.

toSerializableMap

@NotNull
default Map<String,Object> toSerializableMap(@NotNull
                                                      org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration)

Convert the given build configuration to a map that can be serialized and then exported by Bamboo.

The returned map must only contain values of the following types:

• numeric type (e.g. Integer, Double)
• String
• Boolean

Null values are permitted. Nested collections are also allowed, but they must be of the following types:

• Object[]
• Iterable<Object>
• Map<String, Object>

Nested collections must only contain legal values (one of the listed above). Multiple level nesting is allowed.

Parameters:

buildConfiguration - plan's build configuration

Returns:

this plugin's configuration which can be used for exporting