Package com.atlassian.bamboo.v2.build

Interface BuildConfigurationAwarePlugin<T extends com.atlassian.plugin.ModuleDescriptor>

All Superinterfaces:

BambooPluginModule, InitablePluginModule<T>, RenderableBuildConfiguration

All Known Subinterfaces:

BuildTriggerCondition, ConfigurablePlugin<T>, DependenciesPlanConfigurationPlugin, ImportExportAwarePlugin<T,P>, MiscellaneousPlanConfigurationPlugin, PlanConfigurationUiPlugin

All Known Implementing Classes:

ArtifactHandlerForPlanConfigurator, AutomaticDependencyManagementPlugin, BaseBuildConfigurationAwarePlugin, BaseConfigurableBuildPlugin, BaseConfigurablePlugin, BrokenBuildPostProcessor, BuildExpiryPerPlanPlugin, BuildLabellerCustomBuildProcessor, BuildMonitoringPerPlanPlugin, CloverBuildProcessor, ConcurrentBuildsPlanConfigurationPlugin, HangingBuildConfigurationPlugin, HungBuildPlanConfigurationPlugin, PlansGreenCondition, SkipTestHistoryConfigurationItem

public interface BuildConfigurationAwarePlugin<T extends com.atlassian.plugin.ModuleDescriptor>
extends InitablePluginModule<T>, RenderableBuildConfiguration

Method Summary

Modifier and Type	Method	Description
void	addDefaultValues(@NotNull BuildConfiguration buildConfiguration)	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)
default boolean	isConfigurationMissing(@NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)	Checks if HierarchicalConfiguration objects contains plugin's configuration values.
void	prepareConfigObject(@NotNull BuildConfiguration buildConfiguration)	Do any preprocessing work before validation occurs.
@NotNull ErrorCollection	validate(@NotNull BuildConfiguration buildConfiguration)	Validates the properties in the BuildConfiguration object.

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

init

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

getEditHtml, getViewHtml

Method Details

addDefaultValues

void addDefaultValues(@NotNull
 @NotNull BuildConfiguration buildConfiguration)

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)

Parameters:

buildConfiguration - -

prepareConfigObject

void prepareConfigObject(@NotNull
 @NotNull BuildConfiguration buildConfiguration)

Do any preprocessing work before validation occurs. For repository, builder and web repository plugins this will only be called if the plugin is select by the user.

Parameters:

buildConfiguration - -

validate

@NotNull
@NotNull ErrorCollection validate(@NotNull
 @NotNull BuildConfiguration buildConfiguration)

Validates the properties in the BuildConfiguration object. The name of the properties match those passed in through the form fragments in RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan) template.

Parameters:

buildConfiguration - -

Returns:

ErrorCollection keyed by the field name.

isConfigurationMissing

default boolean isConfigurationMissing(@NotNull
 @NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)

Checks if HierarchicalConfiguration objects contains plugin's configuration values. Should return true if call to addDefaultValues() is necessary to initialize HierarchicalConfiguration.

Parameters:

configuration - HierarchicalConfiguration object

Returns:

true if configuration is not present in HierarchicalConfiguration and should be set to defaults

Since:

5.14