Package com.atlassian.bamboo.build.monitoring

Class BuildMonitoringPerPlanPlugin

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.build.monitoring.BuildMonitoringPerPlanPlugin

All Implemented Interfaces:

CustomBuildProcessorServer, InitablePluginModule, BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, RenderableBuildConfiguration, BuildTask, HibernateBuildTask, Callable<BuildContext>

public class BuildMonitoringPerPlanPlugin
extends BaseConfigurablePlugin
implements CustomBuildProcessorServer

Field Summary

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

moduleDescriptor, templateRenderer

Constructor Summary

Constructors

Constructor	Description
BuildMonitoringPerPlanPlugin()

Method Summary

Modifier and Type	Method	Description
@NotNull BuildContext	call()	Execute the build task.
@NotNull Set<String>	getConfigurationKeys()
void	init(@NotNull BuildContext buildContext)
boolean	isConfigurationMissing(@NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)	Checks if HierarchicalConfiguration objects contains plugin's configuration values.
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, 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, prepareConfigObject

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

init

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

getEditHtml, getViewHtml

Constructor Details

BuildMonitoringPerPlanPlugin

public BuildMonitoringPerPlanPlugin()

Method Details

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.

populateContextForView

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

Overrides:

populateContextForView in class BaseBuildConfigurationAwarePlugin

init

public void init(@NotNull
 @NotNull BuildContext buildContext)

Specified by:

init in interface BuildTask

call

@NotNull
public @NotNull BuildContext call()
                           throws Exception

Description copied from interface: BuildTask

Execute the build task.

Implementations should regularly check if the calling Thread has been interrupted.

Specified by:

call in interface BuildTask

Specified by:

call in interface Callable<BuildContext>

Throws:

InterruptedException - if the calling Thread has been interrupted.

Exception - A general exception that will be handled.

getConfigurationKeys

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

isConfigurationMissing

public boolean isConfigurationMissing(@NotNull
 @NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)

Description copied from interface: BuildConfigurationAwarePlugin

Checks if HierarchicalConfiguration objects contains plugin's configuration values. Should return true if call to addDefaultValues() is necessary to initialize HierarchicalConfiguration.

Specified by:

isConfigurationMissing in interface BuildConfigurationAwarePlugin

Parameters:

configuration - HierarchicalConfiguration object

Returns:

true if configuration is not present in HierarchicalConfiguration and should be set to defaults

setTextProvider

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