Package com.atlassian.bamboo.build.expiry.plugin

Class BuildExpiryPerPlanPlugin

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.build.expiry.plugin.BuildExpiryPerPlanPlugin

All Implemented Interfaces:

MiscellaneousPlanConfigurationPlugin, PlanConfigurationUiPlugin, InitablePluginModule, BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, RenderableBuildConfiguration

public class BuildExpiryPerPlanPlugin
extends BaseConfigurablePlugin
implements MiscellaneousPlanConfigurationPlugin

A plugin class that allows you to have build expiry occur per build

Field Summary

Fields

Modifier and Type	Field	Description
static String	BUILD_EXPIRY_CONFIG_CONSTANT
static String	FIELD_ENABLED

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

moduleDescriptor, templateRenderer

Constructor Summary

Constructors

Constructor	Description
BuildExpiryPerPlanPlugin()

Method Summary

Modifier and Type	Method	Description
@NotNull Set<String>	getConfigurationKeys()
String	getSelectedExpiryTypesLabel(@NotNull CombinedExpiryConfig expiryConfig)
boolean	isApplicableTo(@NotNull ImmutablePlan plan)	Checks if the plugin is applicable to a plan.
protected void	populateContextForEdit(@NotNull Map<String,Object> context, @NotNull BuildConfiguration buildConfiguration, @Nullable Plan plan)
protected void	populateContextForView(@NotNull Map<String,Object> context, @NotNull Plan plan)
void	setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)
@NotNull ErrorCollection	validate(@NotNull BuildConfiguration buildConfiguration)	Validates the properties in the BuildConfiguration object.

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

customizeBuildRequirements, removeBuildRequirements

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

addDefaultValues, getEditHtml, getTemplateRenderer, getViewHtml, init, 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

BUILD_EXPIRY_CONFIG_CONSTANT

public static final String BUILD_EXPIRY_CONFIG_CONSTANT

See Also:

Constant Field Values

FIELD_ENABLED

public static final String FIELD_ENABLED

See Also:

Constant Field Values

Constructor Detail

BuildExpiryPerPlanPlugin

public BuildExpiryPerPlanPlugin()

Method Detail

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

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.

populateContextForEdit

protected void populateContextForEdit(@NotNull
                                      @NotNull Map<String,Object> context,
                                      @NotNull
                                      @NotNull BuildConfiguration buildConfiguration,
                                      @Nullable
                                      @Nullable Plan plan)

Overrides:

populateContextForEdit in class BaseBuildConfigurationAwarePlugin

populateContextForView

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

Overrides:

populateContextForView in class BaseBuildConfigurationAwarePlugin

getConfigurationKeys

@NotNull
public @NotNull Set<String> getConfigurationKeys()

getSelectedExpiryTypesLabel

public String getSelectedExpiryTypesLabel(@NotNull
                                          @NotNull CombinedExpiryConfig expiryConfig)

setTextProvider

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