com.atlassian.bamboo.v2.build
Interface ConfigurablePlugin

All Superinterfaces:
BambooPluginModule
All Known Subinterfaces:
Builder, CleanCheckoutAwareRepository, EnvironmentVariablesAwareBuilder, IncludeExcludeAwareRepository, InitialBuildAwareRepository, MutableEnvironmentVariablesAwareBuilder, MutableQuietPeriodAwareRepository, PostConfigurableRepository, QuietPeriodAwareRepository, Repository, RepositoryEventAware, SelectableAuthenticationRepository, WebRepositoryEnabledRepository
All Known Implementing Classes:
AbstractBuilder, AbstractMavenBuilder, AbstractRepository, AntBuilder, AutoLabelBuildCompleteAction, BaseConfigurableBuildPlugin, BaseConfigurablePlugin, BuildExpiryPerPlanPlugin, BuildLabeller, BuildMonitoringPerPlanPlugin, CloverBuildProcessor, CustomCommandBuilder, CVSRepository, Maven2Builder, MavenBuilder, PerforceRepository, PhpUnitBuilder, ScriptBuilder, SvnRepository

public interface ConfigurablePlugin
extends BambooPluginModule


Method Summary
 void addDefaultValues(BuildConfiguration buildConfiguration)
          Extension point for adding default values to the form for #getEditHtml()
 void customizeBuildRequirements(BuildConfiguration buildConfiguration, RequirementSet requirementSet)
          Extension point for adding/customizing requiremnents when editing a build's builder configuration.
 java.lang.String getEditHtml(BuildConfiguration buildConfiguration, Build build)
          Returns HTML that represents the form fragment for editing the repository.
 java.lang.String getViewHtml(Build build)
          Returns the HTML that represents the view of the repository configuration
 void init(com.atlassian.plugin.ModuleDescriptor moduleDescriptor)
          Initialises the Plugin with the plugin module descriptor
 void prepareConfigObject(BuildConfiguration buildConfiguration)
          Do any preprocessing work before validation occurs
 ErrorCollection validate(BuildConfiguration buildConfiguration)
          Validates the properties in the BuildConfiguration object.
 

Method Detail

init

void init(@NotNull
          com.atlassian.plugin.ModuleDescriptor moduleDescriptor)
Initialises the Plugin with the plugin module descriptor

Parameters:
moduleDescriptor -

addDefaultValues

void addDefaultValues(@NotNull
                      BuildConfiguration buildConfiguration)
Extension point for adding default values to the form for #getEditHtml()

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() 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 requiremnents when editing a build's builder configuration.

Parameters:
buildConfiguration -

getViewHtml

@Nullable
java.lang.String getViewHtml(@NotNull
                                      Build build)
Returns the HTML that represents the view of the repository configuration

Returns:
HTML string. May be null.

getEditHtml

@Nullable
java.lang.String getEditHtml(@NotNull
                                      BuildConfiguration buildConfiguration,
                                      @NotNull
                                      Build build)
Returns HTML that represents the form fragment for editing the repository. No opening and closing form tags are required.

Returns:
HTMK string. May be null.


Copyright © 2009 Atlassian Pty Ltd. All Rights Reserved.