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:

InitablePluginModule, CustomBuildDefinitionTransformer, BambooPluginModule, BuildConfigurationAwarePlugin, BuildConfigurationUIPlugin, MiscellaneousBuildConfigurationPlugin

public class ConcurrentBuildsPlanConfigurationPlugin
extends BaseBuildConfigurationAwarePlugin
implements MiscellaneousBuildConfigurationPlugin

Field Summary

static java.lang.String

CONCURRENT_BUILD_OBJECT_KEY

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

moduleDescriptor, templateRenderer

Constructor Summary

ConcurrentBuildsPlanConfigurationPlugin()

Method Summary

boolean	isApplicableTo(Plan plan) Checks if the plugin is applicable to a plan.
protected void	populateContextForView(java.util.Map<java.lang.String,java.lang.Object> context, Plan plan)
void	setAdministrationConfigurationManager(AdministrationConfigurationManager administrationConfigurationManager)
void	setTextProvider(com.opensymphony.xwork.TextProvider textProvider)
void	transformBuildDefinition(java.util.Map<java.lang.String,java.lang.Object> configObjects, java.util.Map<java.lang.String,java.lang.String> configParameters, BuildDefinition buildDefinition) Implementors can add their custom objects to the configObjects map.
ErrorCollection	validate(BuildConfiguration buildConfiguration) Validates the properties in the BuildConfiguration object.

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

addDefaultValues, getEditHtml, getViewHtml, init, isConfigurationMissing, 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.configuration.BuildConfigurationUIPlugin

isConfigurationMissing

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

addDefaultValues, getEditHtml, getViewHtml, prepareConfigObject

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

init

Field Detail

CONCURRENT_BUILD_OBJECT_KEY

public static final java.lang.String CONCURRENT_BUILD_OBJECT_KEY

See Also:

Constant Field Values

Constructor Detail

ConcurrentBuildsPlanConfigurationPlugin

public ConcurrentBuildsPlanConfigurationPlugin()

Method Detail

populateContextForView

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

Overrides:

populateContextForView in class BaseBuildConfigurationAwarePlugin

validate

@NotNull
public ErrorCollection validate(@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 BuildConfigurationAwarePlugin.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 - - @NotNull

Returns:

ErrorCollection keyed by the field name. @NotNull

transformBuildDefinition

public void transformBuildDefinition(@NotNull
                                     java.util.Map<java.lang.String,java.lang.Object> configObjects,
                                     @NotNull
                                     java.util.Map<java.lang.String,java.lang.String> configParameters,
                                     @NotNull
                                     BuildDefinition buildDefinition)

Description copied from interface: CustomBuildDefinitionTransformer

Implementors can add their custom objects to the configObjects map. The key should be unique to plugin... It's better to be descriptive. It is possible to also update the buildDefinition directly, but it's not recommended.

Specified by:

transformBuildDefinition in interface CustomBuildDefinitionTransformer

Parameters:

configObjects - - Map - string key, object value. A map to put custom objects into. @NotNull

configParameters - - Map - String key, string value. These are taken from all fields that begin with "custom."

buildDefinition - - the fully constructed BuildDefinition @NotNull

isApplicableTo

public boolean isApplicableTo(@NotNull
                              Plan plan)

Description copied from interface: BuildConfigurationUIPlugin

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 BuildConfigurationUIPlugin

Parameters:

plan - Plan to be verified

Returns:

true if particular configuration is applicable to input plan

setTextProvider

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

setAdministrationConfigurationManager

public void setAdministrationConfigurationManager(AdministrationConfigurationManager administrationConfigurationManager)