com.atlassian.bamboo.v2.build
Interface BuildConfigurationAwarePlugin

All Superinterfaces:

BambooPluginModule, InitablePluginModule

All Known Subinterfaces:

BuildConfigurationUIPlugin, Builder, CleanCheckoutAwareRepository, CleanWorkingDirectoryAwareRepository, CommitUrlProvider, ConfigurablePlugin, DependenciesBuildConfigurationPlugin, EnvironmentVariablesAwareBuilder, IncludeExcludeAwareRepository, InitialBuildAwareRepository, MavenPomAccessorCapableRepository, MiscellaneousBuildConfigurationPlugin, MutableEnvironmentVariablesAwareBuilder, MutableQuietPeriodAwareRepository, PostConfigurableBuilder, PostConfigurableRepository, QuietPeriodAwareRepository, Repository, RepositoryEventAware, SelectableAuthenticationRepository, WebRepositoryViewer

All Known Implementing Classes:

AbstractBuilder, AbstractMavenBuilder, AbstractPhpUnitBuilder, AbstractRepository, AbstractWebRepositoryViewer, AntBuilder, AutoLabelBuildCompleteAction, AutomaticDependencyManagementPlugin, BaseBuildConfigurationAwarePlugin, BaseConfigurableBuildPlugin, BaseConfigurablePlugin, BuildExpiryPerPlanPlugin, BuildLabeller, BuildMonitoringPerPlanPlugin, CloverBuildProcessor, ConcurrentBuildsPlanConfigurationPlugin, CustomCommandBuilder, CVSRepository, DefaultWebRepositoryViewer, FisheyeWebRepositoryViewer, GrailsBuilder, HgRepository, HgWebRepositoryViewer, Maven2Builder, Maven2BuildProcessor, MavenBuilder, NoWebRepositoryViewer, PerforceRepository, PhpUnit33XBuilder, PhpUnitBuilder, ScriptBuilder, SvnRepository

public interface BuildConfigurationAwarePlugin
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)
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.
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. For repository, builder and web repository plugins this will only be called if the plugin is select by the user.

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

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,
                                      @Nullable
                                      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.

plan - Plan for which edit HTML has to be rendered. May be null during creation phase of plan.

Returns:

HTML string. May be null.