Package com.atlassian.bamboo.build.monitoring

Class HangingBuildConfigurationPlugin

java.lang.Object
com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
com.atlassian.bamboo.build.monitoring.HangingBuildConfigurationPlugin
All Implemented Interfaces:
InitablePluginModule, BambooPluginModule, BuildConfigurationAwarePlugin, ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.HangingBuildConfiguration,com.atlassian.bamboo.specs.api.model.plan.configuration.HangingBuildConfigurationProperties>, RenderableBuildConfiguration
public class HangingBuildConfigurationPlugin extends BaseBuildConfigurationAwarePlugin implements ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.HangingBuildConfiguration,com.atlassian.bamboo.specs.api.model.plan.configuration.HangingBuildConfigurationProperties>

  • Constructor Details

    • HangingBuildConfigurationPlugin

      public HangingBuildConfigurationPlugin()

  • Method Details

    • getConfigurationKeys

      @NotNull public @NotNull Set<String> getConfigurationKeys()
      Description copied from interface: ImportExportAwarePlugin
      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.

      Specified by:
      getConfigurationKeys in interface ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.HangingBuildConfiguration,com.atlassian.bamboo.specs.api.model.plan.configuration.HangingBuildConfigurationProperties>

    • isConfigurationMissing

      public boolean isConfigurationMissing(@NotNull @NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)
      Description copied from interface: BuildConfigurationAwarePlugin
      Checks if HierarchicalConfiguration objects contains plugin's configuration values. Should return true if call to addDefaultValues() is necessary to initialize HierarchicalConfiguration.
      Specified by:
      isConfigurationMissing in interface BuildConfigurationAwarePlugin
      Parameters:
      configuration - HierarchicalConfiguration object
      Returns:
      true if configuration is not present in HierarchicalConfiguration and should be set to defaults

    • addToBuildConfiguration

      public void addToBuildConfiguration(@NotNull @NotNull com.atlassian.bamboo.specs.api.model.plan.configuration.HangingBuildConfigurationProperties specsProperties, @NotNull @NotNull org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration)
      Description copied from interface: ImportExportAwarePlugin
      Validate and add data from specs properties to passed build configuration.
      Specified by:
      addToBuildConfiguration in interface ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.HangingBuildConfiguration,com.atlassian.bamboo.specs.api.model.plan.configuration.HangingBuildConfigurationProperties>
      Parameters:
      specsProperties -
      buildConfiguration -

    • toSpecsEntity

      @NotNull public @NotNull com.atlassian.bamboo.specs.api.builders.plan.configuration.HangingBuildConfiguration toSpecsEntity(@NotNull @NotNull org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration)
      Description copied from interface: ImportExportAwarePlugin
      Export configuration of this plugin to Bamboo Specs entity.
      Specified by:
      toSpecsEntity in interface ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.HangingBuildConfiguration,com.atlassian.bamboo.specs.api.model.plan.configuration.HangingBuildConfigurationProperties>

    • addDefaultValues

      public void addDefaultValues(@NotNull @NotNull BuildConfiguration buildConfiguration)
      Description copied from interface: BuildConfigurationAwarePlugin
      Extension point for adding default values to the form for RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)
      Specified by:
      addDefaultValues in interface BuildConfigurationAwarePlugin
      Overrides:
      addDefaultValues in class BaseBuildConfigurationAwarePlugin
      Parameters:
      buildConfiguration - -

    • toYaml

      @Nullable public @Nullable Node toYaml(@NotNull @NotNull com.atlassian.bamboo.specs.api.model.plan.configuration.HangingBuildConfigurationProperties specsProperties)
      Description copied from interface: ImportExportAwarePlugin
      Convert configuration of this plugin from Bamboo Specs to YAML structure.
      Specified by:
      toYaml in interface ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.HangingBuildConfiguration,com.atlassian.bamboo.specs.api.model.plan.configuration.HangingBuildConfigurationProperties>
      Returns:
      YAML Node containing representation of Bamboo Specs entity.

    • fromYaml

      @Nullable public @Nullable com.atlassian.bamboo.specs.api.builders.plan.configuration.HangingBuildConfiguration fromYaml(@NotNull @NotNull Node node) throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException
      Description copied from interface: ImportExportAwarePlugin
      Import configuration of this plugin from YAML node to Bamboo Specs entity.
      Specified by:
      fromYaml in interface ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.HangingBuildConfiguration,com.atlassian.bamboo.specs.api.model.plan.configuration.HangingBuildConfigurationProperties>
      Parameters:
      node - yaml node
      Returns:
      Bamboo Specs entity for plugin settings.
      Throws:
      com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException - if configuration is wrong.