Package com.atlassian.bamboo.deployments.configuration

Interface CustomEnvironmentConfigPluginExporter

public interface CustomEnvironmentConfigPluginExporter

Method Summary

Modifier and Type	Method	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(@NotNull Node node)	Deprecated. since 8.1.
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 String key, @NotNull Node node)	Read configuration from YAML Node.
@NotNull Map<String,String>	toConfiguration(@NotNull com.atlassian.bamboo.specs.api.model.deployment.configuration.EnvironmentPluginConfigurationProperties configurationProperties)
@NotNull com.atlassian.bamboo.specs.api.builders.deployment.configuration.EnvironmentPluginConfiguration	toSpecsEntity(@NotNull 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> @Nullable Node	toYaml(P specsProperties)	Convert configuration of this plugin from Bamboo Specs to YAML structure.
@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.

Method Detail

toSpecsEntity

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

toConfiguration

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

validate

@NotNull
@NotNull List<com.atlassian.bamboo.specs.api.validators.common.ValidationProblem> validate(@NotNull
                                                                                           @NotNull TaskValidationContext validationContext,
                                                                                           @NotNull
                                                                                           @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
@Deprecated
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
                                                                                                                                                                                                                                                         @NotNull Node node)
                                                                                                                                                                                                                                                  throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Deprecated.

since 8.1. Use fromYaml(String, Node).

Read configuration from YAML Node. node is map containing all plugins configuration map.

Parameters:

node - yaml node

Returns:

plugin configuration

Throws:

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

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
                                                                                                                                                                                                                                                         @NotNull String key,
                                                                                                                                                                                                                                                         @NotNull
                                                                                                                                                                                                                                                         @NotNull Node node)
                                                                                                                                                                                                                                                  throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Read configuration from YAML Node.

Parameters:

key - plugin key or plugin keyword.

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> @Nullable Node toYaml(@NotNull
                                                                                                                                                                                                                                                                    P specsProperties)

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

Returns:

map node containing YAML representation of Bamboo Specs entity.