com.atlassian.bamboo.deployments.configuration

Interface CustomEnvironmentConfigPluginExporter

public interface CustomEnvironmentConfigPluginExporter

Method Summary

Modifier and Type	Method and Description
default <T extends com.atlassian.bamboo.specs.api.builders.deployment.configuration.EnvironmentPluginConfiguration<P>,P extends com.atlassian.bamboo.specs.api.model.deployment.configuration.EnvironmentPluginConfigurationProperties> T	fromYaml(Node node) Read configuration from YAML Node.
Map<String,String>	toConfiguration(com.atlassian.bamboo.specs.api.model.deployment.configuration.EnvironmentPluginConfigurationProperties configurationProperties)
com.atlassian.bamboo.specs.api.builders.deployment.configuration.EnvironmentPluginConfiguration	toSpecsEntity(Map<String,String> configuration)
default <T extends com.atlassian.bamboo.specs.api.builders.deployment.configuration.EnvironmentPluginConfiguration<P>,P extends com.atlassian.bamboo.specs.api.model.deployment.configuration.EnvironmentPluginConfigurationProperties> Node	toYaml(P specsProperties) Convert configuration of this plugin from Bamboo Specs to YAML structure.
List<com.atlassian.bamboo.specs.api.validators.common.ValidationProblem>	validate(TaskValidationContext validationContext, com.atlassian.bamboo.specs.api.model.deployment.configuration.EnvironmentPluginConfigurationProperties configurationProperties) Validates plugin configuration in context of enclosing deployment properties.

Method Detail

toSpecsEntity

@NotNull
com.atlassian.bamboo.specs.api.builders.deployment.configuration.EnvironmentPluginConfiguration toSpecsEntity(@NotNull
                                                                                                                       Map<String,String> configuration)

toConfiguration

@NotNull
Map<String,String> toConfiguration(@NotNull
                                            com.atlassian.bamboo.specs.api.model.deployment.configuration.EnvironmentPluginConfigurationProperties configurationProperties)

validate

@NotNull
List<com.atlassian.bamboo.specs.api.validators.common.ValidationProblem> validate(@NotNull
                                                                                           TaskValidationContext validationContext,
                                                                                           @NotNull
                                                                                           com.atlassian.bamboo.specs.api.model.deployment.configuration.EnvironmentPluginConfigurationProperties configurationProperties)

Validates plugin configuration in context of enclosing deployment properties. Should check for any inconsistencies between plugin config and the rest of deployment content, as it is provided in the validation context. Returns list of validation errors or empty if everything is ok.

Should check RSS permissions if necessary.

fromYaml

@Nullable
default <T extends com.atlassian.bamboo.specs.api.builders.deployment.configuration.EnvironmentPluginConfiguration<P>,P extends com.atlassian.bamboo.specs.api.model.deployment.configuration.EnvironmentPluginConfigurationProperties> T fromYaml(@NotNull
                                                                                                                                                                                                                                                             Node node)
                                                                                                                                                                                                                                                      throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Read configuration from YAML Node.

Parameters:

node - yaml node

Returns:

plugin configuration

Throws:

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

toYaml

@Nullable
default <T extends com.atlassian.bamboo.specs.api.builders.deployment.configuration.EnvironmentPluginConfiguration<P>,P extends com.atlassian.bamboo.specs.api.model.deployment.configuration.EnvironmentPluginConfigurationProperties> Node toYaml(@NotNull
                                                                                                                                                                                                                                                              P specsProperties)

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

Returns:

map node containing YML representation of Bamboo Specs entity.