Package com.atlassian.bamboo.build.configuration

Class ConcurrentBuildsPlanConfigurationPlugin

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.build.configuration.ConcurrentBuildsPlanConfigurationPlugin

All Implemented Interfaces:

MiscellaneousPlanConfigurationPlugin, PlanConfigurationUiPlugin, InitablePluginModule, BambooPluginModule, BuildConfigurationAwarePlugin, ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>, RenderableBuildConfiguration

public class ConcurrentBuildsPlanConfigurationPlugin
extends BaseBuildConfigurationAwarePlugin
implements MiscellaneousPlanConfigurationPlugin, ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONCURRENT_BUILD_OBJECT_KEY
static String	NUMBER_CONCURRENT_BUILDS
static String	NUMBER_CONCURRENT_BUILDS_OVERRIDE

Fields inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

moduleDescriptor, templateRenderer

Constructor Summary

Constructors

Constructor	Description
ConcurrentBuildsPlanConfigurationPlugin()

Method Summary

Modifier and Type	Method	Description
void	addToBuildConfiguration(@NotNull com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties specsProperties, @NotNull org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration)	Validate and add data from specs properties to passed build configuration.
@Nullable com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds	fromYaml(@NotNull Node node)	Import configuration of this plugin from YAML node to Bamboo Specs entity.
@NotNull Set<String>	getConfigurationKeys()	Return all property keys related to this plugin module which may exist in a plan's BuildConfiguration.
boolean	isApplicableTo(@NotNull ImmutablePlan plan)	Checks if the plugin is applicable to a plan.
protected void	populateContextForView(@NotNull Map<String,Object> context, @NotNull Plan plan)
void	setAdministrationConfigurationAccessor(AdministrationConfigurationAccessor administrationConfigurationAccessor)
void	setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)
@NotNull com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds	toSpecsEntity(@NotNull org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration)	Export configuration of this plugin to Bamboo Specs entity.
@Nullable Node	toYaml(@NotNull com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties specsProperties)	Convert configuration of this plugin from Bamboo Specs to YAML structure.
@NotNull ErrorCollection	validate(@NotNull BuildConfiguration buildConfiguration)	Validates the properties in the BuildConfiguration object.

Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

addDefaultValues, getEditHtml, getTemplateRenderer, getViewHtml, init, populateContextForEdit, prepareConfigObject, setTemplateRenderer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addDefaultValues, isConfigurationMissing, prepareConfigObject

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

init

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

getEditHtml, getViewHtml

Field Detail

CONCURRENT_BUILD_OBJECT_KEY

public static final String CONCURRENT_BUILD_OBJECT_KEY

See Also:

Constant Field Values

NUMBER_CONCURRENT_BUILDS_OVERRIDE

public static final String NUMBER_CONCURRENT_BUILDS_OVERRIDE

See Also:

Constant Field Values

NUMBER_CONCURRENT_BUILDS

public static final String NUMBER_CONCURRENT_BUILDS

See Also:

Constant Field Values

Constructor Detail

ConcurrentBuildsPlanConfigurationPlugin

public ConcurrentBuildsPlanConfigurationPlugin()

Method Detail

populateContextForView

protected void populateContextForView(@NotNull
                                      @NotNull Map<String,Object> context,
                                      @NotNull
                                      @NotNull Plan plan)

Overrides:

populateContextForView in class BaseBuildConfigurationAwarePlugin

validate

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

Description copied from interface: BuildConfigurationAwarePlugin

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.

Specified by:

validate in interface BuildConfigurationAwarePlugin

Overrides:

validate in class BaseBuildConfigurationAwarePlugin

Parameters:

buildConfiguration - -

Returns:

ErrorCollection keyed by the field name.

isApplicableTo

public boolean isApplicableTo(@NotNull
                              @NotNull ImmutablePlan plan)

Description copied from interface: PlanConfigurationUiPlugin

Checks if the plugin is applicable to a plan. Typical implementation is to check plan's type (chain, build, job).

Specified by:

isApplicableTo in interface PlanConfigurationUiPlugin

Parameters:

plan - Plan to be verified

Returns:

true if particular configuration is applicable to input plan

toSpecsEntity

@NotNull
public @NotNull com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds 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.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>

addToBuildConfiguration

public void addToBuildConfiguration(@NotNull
                                    @NotNull com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties 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.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>

toYaml

@Nullable
public @Nullable Node toYaml(@NotNull
                             @NotNull com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties 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.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>

Returns:

YAML Node containing representation of Bamboo Specs entity.

fromYaml

@Nullable
public @Nullable com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds 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.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>

Parameters:

node - yaml node

Returns:

Bamboo Specs entity for plugin settings.

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException - if configuration is wrong.

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.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>

setAdministrationConfigurationAccessor

public void setAdministrationConfigurationAccessor(AdministrationConfigurationAccessor administrationConfigurationAccessor)

setTextProvider

public void setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)