com.atlassian.bamboo.plugins.labeller

Class BuildLabeller

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.plugins.labeller.BuildLabeller

All Implemented Interfaces:

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

public class BuildLabeller
extends BaseConfigurablePlugin
implements CustomPostBuildCompletedAction, ImportExportAwarePlugin

Field Summary

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

moduleDescriptor, templateRenderer

Constructor Summary

Constructors

Constructor and Description
BuildLabeller()

Method Summary

Modifier and Type	Method and Description
BuildContext	call() This action will run after a build has completed.
protected BuildLogFileAccessor	getBuildLogFileAccessor(Key planKey, int buildNumber)
Set<String>	getConfigurationKeys() Return all property keys related to this plugin module which may exist in a plan's BuildConfiguration.
LabelManager	getLabelManager()
void	init(BuildContext buildContext)
boolean	isConfigurationMissing(org.apache.commons.configuration.HierarchicalConfiguration configuration) Checks if HierarchicalConfiguration objects contains plugin's configuration values.
void	setBuildLogFileAccessorFactory(BuildLogFileAccessorFactory buildLogFileAccessorFactory)
void	setCustomVariableContext(CustomVariableContext customVariableContext)
void	setLabelManager(LabelManager labelManager)
void	setPlanManager(PlanManager planManager)
void	setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)
ErrorCollection	validate(BuildConfiguration buildConfiguration) This method is used to validate a build configuration for a build plan

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

customizeBuildRequirements, removeBuildRequirements

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

addDefaultValues, getEditHtml, getViewHtml, init, populateContextForEdit, populateContextForView, 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.ImportExportAwarePlugin

toSerializableMap

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 Detail

BuildLabeller

public BuildLabeller()

Method Detail

init

public void init(@NotNull
                 BuildContext buildContext)

Specified by:

init in interface BuildTask

call

@NotNull
public BuildContext call()
                           throws InterruptedException,
                                  Exception

This action will run after a build has completed.

The build will be tagged with a specified set of labels if the logs matches the specified regex pattern.

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.

validate

@NotNull
public ErrorCollection validate(@NotNull
                                         BuildConfiguration buildConfiguration)

This method is used to validate a build configuration for a build plan

This is used if the CustomBuildCompleteAction needs to have configuration stored against the build plan.

Specified by:

validate in interface BuildConfigurationAwarePlugin

Overrides:

validate in class BaseBuildConfigurationAwarePlugin

Parameters:

buildConfiguration - Build configuration object

Returns:

Collections of errors found during validation

isConfigurationMissing

public boolean isConfigurationMissing(@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

getConfigurationKeys

@NotNull
public Set<String> getConfigurationKeys()

Description copied from interface: ImportExportAwarePlugin

Return all property keys related to this plugin module which may exist in a plan's BuildConfiguration. The returned set may be immutable. If a plugin module doesn't have configuration, then an empty set should be returned.

Specified by:

getConfigurationKeys in interface ImportExportAwarePlugin

getLabelManager

public LabelManager getLabelManager()

setLabelManager

public void setLabelManager(LabelManager labelManager)

getBuildLogFileAccessor

protected BuildLogFileAccessor getBuildLogFileAccessor(Key planKey,
                                                       int buildNumber)

setBuildLogFileAccessorFactory

public void setBuildLogFileAccessorFactory(BuildLogFileAccessorFactory buildLogFileAccessorFactory)

setCustomVariableContext

public void setCustomVariableContext(CustomVariableContext customVariableContext)

setPlanManager

public void setPlanManager(PlanManager planManager)

setResultsSummaryManager

public void setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)