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

java.lang.Object
  com.atlassian.bamboo.v2.build.BaseConfigurablePlugin
      com.atlassian.bamboo.build.expiry.plugin.BuildExpiryPerPlanPlugin

All Implemented Interfaces:

CustomBuildCompleteAction, InitablePluginModule, CustomBuildDefinitionTransformer, BambooPluginModule, ConfigurablePlugin

public class BuildExpiryPerPlanPlugin
extends BaseConfigurablePlugin
implements CustomBuildDefinitionTransformer, CustomBuildCompleteAction

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

Field Summary

static java.lang.String	BUILD_EXPIRY_CONFIG_CONSTANT
protected com.opensymphony.xwork.TextProvider	textProvider

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

moduleDescriptor, templateRenderer

Constructor Summary

BuildExpiryPerPlanPlugin()

Method Summary

protected void	populateContextForEdit(java.util.Map<java.lang.String,java.lang.Object> context, BuildConfiguration buildConfiguration, Plan plan)
protected void	populateContextForView(java.util.Map<java.lang.String,java.lang.Object> context, Plan plan)
void	run(Build build, BuildResults buildResult) This action will run when a build completes.
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) Implemtors can add their custom objects to the configObjects map.
ErrorCollection	validate(BuildConfiguration config) Validates the properties in the BuildConfiguration object.

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

addDefaultValues, customizeBuildRequirements, getEditHtml, getViewHtml, init, prepareConfigObject, removeBuildRequirements, setTemplateRenderer

Methods inherited from class java.lang.Object

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

Field Detail

BUILD_EXPIRY_CONFIG_CONSTANT

public static final java.lang.String BUILD_EXPIRY_CONFIG_CONSTANT

See Also:

Constant Field Values

textProvider

protected com.opensymphony.xwork.TextProvider textProvider

Constructor Detail

BuildExpiryPerPlanPlugin

public BuildExpiryPerPlanPlugin()

Method Detail

run

public void run(@NotNull
                Build build,
                @NotNull
                BuildResults buildResult)

Description copied from interface: CustomBuildCompleteAction

This action will run when a build completes.

Specified by:

run in interface CustomBuildCompleteAction

Parameters:

build - - the Build plan object

buildResult - - the BuildResults object that holds information

validate

@NotNull
public ErrorCollection validate(@NotNull
                                        BuildConfiguration config)

Description copied from interface: ConfigurablePlugin

Validates the properties in the BuildConfiguration object. The name of the properties match those passed in through the form fragments in ConfigurablePlugin.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan) template.

Specified by:

validate in interface ConfigurablePlugin

Overrides:

validate in class BaseConfigurablePlugin

Parameters:

config - - @NotNull

Returns:

ErrorCollection keyed by the field name. @NotNull

populateContextForEdit

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

Overrides:

populateContextForEdit in class BaseConfigurablePlugin

populateContextForView

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

Overrides:

populateContextForView in class BaseConfigurablePlugin

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

Implemtors can add their custom objects to the configObjects map. The key should be unqiue to plugin... It's better to be descriptive. It is possible to also updat the buildDefinition directly, but it's not recomended.

Specified by:

transformBuildDefinition in interface CustomBuildDefinitionTransformer

Parameters:

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

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

buildDefinition - - the fully contructed BuildDefinition @NotNull

setTextProvider

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