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, CustomBuildDefinitionTransformer, BambooPluginModule, ConfigurablePlugin
public class BuildExpiryPerPlanPlugin
- extends BaseConfigurablePlugin
- implements CustomBuildDefinitionTransformer, CustomBuildCompleteAction
A plugin class that allows you to have build expiry occur per build
Method Summary |
protected void |
populateContextForEdit(java.util.Map<java.lang.String,java.lang.Object> context,
BuildConfiguration buildConfiguration,
Build build)
|
protected void |
populateContextForView(java.util.Map<java.lang.String,java.lang.Object> context,
Build build)
|
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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
BuildExpiryPerPlanPlugin
public BuildExpiryPerPlanPlugin()
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 objectbuildResult
- - 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 #getEditHtml()
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
Build build)
- Overrides:
populateContextForEdit
in class BaseConfigurablePlugin
populateContextForView
protected void populateContextForView(@NotNull
java.util.Map<java.lang.String,java.lang.Object> context,
@NotNull
Build build)
- 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. @NotNullconfigParameters
- - 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)
Copyright © 2008 Atlassian Pty Ltd. All Rights Reserved.