com.atlassian.bamboo.v2.build
Interface ConfigurablePlugin

All Superinterfaces:

BambooPluginModule, InitablePluginModule

All Known Subinterfaces:

AdHocAccessAwareRepository, Builder, ChainConfigurationPanel, CleanCheckoutAwareRepository, CleanWorkingDirectoryAwareRepository, CommitUrlProvider, EnvironmentVariablesAwareBuilder, IncludeExcludeAwareRepository, InitialBuildAwareRepository, MavenPomAccessorCapableRepository, MutableEnvironmentVariablesAwareBuilder, MutableQuietPeriodAwareRepository, PostConfigurableBuilder, PostConfigurableRepository, QuietPeriodAwareRepository, Repository, RepositoryEventAware, SelectableAuthenticationRepository, WebRepositoryViewer

All Known Implementing Classes:

AbstractBuilder, AbstractChainConfigurationPanel, AbstractJdkBuilder, AbstractMavenBuilder, AbstractRepository, AbstractWebRepositoryViewer, AntBuilder, AutoLabelBuildCompleteAction, BaseConfigurableBuildPlugin, BaseConfigurablePlugin, BuildExpiryPerPlanPlugin, BuildLabeller, BuildMonitoringPerPlanPlugin, CloverBuildProcessor, CustomCommandBuilder, CVSRepository, DefaultWebRepositoryViewer, FisheyeWebRepositoryViewer, GrailsBuilder, Maven2Builder, Maven2BuildProcessor, MavenBuilder, NoWebRepositoryViewer, PerforceRepository, PhpUnitBuilder, ScriptBuilder, SvnRepository

public interface ConfigurablePlugin
extends InitablePluginModule

Method Summary

void	addDefaultValues(BuildConfiguration buildConfiguration) Extension point for adding default values to the form for getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)
void	customizeBuildRequirements(BuildConfiguration buildConfiguration, RequirementSet requirementSet) Extension point for adding/customizing requirements when editing a build's builder configuration.
java.lang.String	getEditHtml(BuildConfiguration buildConfiguration, Plan plan) Returns HTML that represents the form fragment for editing the repository.
java.lang.String	getViewHtml(Plan plan) Returns the HTML that represents the view of the repository configuration
void	prepareConfigObject(BuildConfiguration buildConfiguration) Do any preprocessing work before validation occurs
void	removeBuildRequirements(BuildConfiguration buildConfiguration, RequirementSet requirementSet) Extension point for removing requirements when given plugin is excluded from build's builder configuration.
ErrorCollection	validate(BuildConfiguration buildConfiguration) Validates the properties in the BuildConfiguration object.

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

init

Method Detail

addDefaultValues

void addDefaultValues(@NotNull
                      BuildConfiguration buildConfiguration)

Extension point for adding default values to the form for getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)

Parameters:

buildConfiguration - - @NotNull

prepareConfigObject

void prepareConfigObject(@NotNull
                         BuildConfiguration buildConfiguration)

Do any preprocessing work before validation occurs

Parameters:

buildConfiguration - - @NotNull

validate

@NotNull
ErrorCollection validate(@NotNull
                                 BuildConfiguration buildConfiguration)

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

Parameters:

buildConfiguration - - @NotNull

Returns:

ErrorCollection keyed by the field name. @NotNull

customizeBuildRequirements

void customizeBuildRequirements(@NotNull
                                BuildConfiguration buildConfiguration,
                                @NotNull
                                RequirementSet requirementSet)

Extension point for adding/customizing requirements when editing a build's builder configuration.

Parameters:

buildConfiguration - source of information for customizing build requirements

requirementSet - requirements to be customized

removeBuildRequirements

void removeBuildRequirements(@NotNull
                             BuildConfiguration buildConfiguration,
                             @NotNull
                             RequirementSet requirementSet)

Extension point for removing requirements when given plugin is excluded from build's builder configuration.

Parameters:

buildConfiguration - source of information for customizing build requirements

requirementSet - requirements to be customized

getViewHtml

@Nullable
java.lang.String getViewHtml(@NotNull
                                      Plan plan)

Returns the HTML that represents the view of the repository configuration

Parameters:

build - Build for which view HTML has to be rendered.

plan -

Returns:

HTML string. May be null.

getEditHtml

@Nullable
java.lang.String getEditHtml(@NotNull
                                      BuildConfiguration buildConfiguration,
                                      @NotNull
                                      Plan plan)

Returns HTML that represents the form fragment for editing the repository. No opening and closing form tags are required.

Parameters:

buildConfiguration - BuildConfiguration for which edit HTML has to be rendered.

build - Build for which edit HTML has to be rendered.

Returns:

HTML string. May be null.