Package com.atlassian.bamboo.plugins.labeller

Class BuildLabellerCustomBuildProcessor

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.v2.build.BaseConfigurableBuildPlugin

com.atlassian.bamboo.plugins.labeller.BuildLabellerCustomBuildProcessor

All Implemented Interfaces:

CustomBuildProcessor, InitablePluginModule, BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, RenderableBuildConfiguration, AgentBuildTask, BuildTask, Callable<BuildContext>

public class BuildLabellerCustomBuildProcessor
extends BaseConfigurableBuildPlugin
implements CustomBuildProcessor

Field Summary

Fields

Modifier and Type	Field	Description
protected BuildLoggerManager	buildLoggerManager

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

buildContext

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

moduleDescriptor, templateRenderer

Constructor Summary

Constructors

Constructor	Description
BuildLabellerCustomBuildProcessor()

Method Summary

Modifier and Type	Method	Description
@NotNull BuildContext	call()	Execute the build task.
@NotNull Set<String>	getConfigurationKeys()
boolean	isConfigurationMissing(@NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)	Checks if HierarchicalConfiguration objects contains plugin's configuration values.
void	setBuildLoggerManager(BuildLoggerManager buildLoggerManager)
void	setCustomVariableContext(CustomVariableContext customVariableContext)
@NotNull ErrorCollection	validate(@NotNull BuildConfiguration buildConfiguration)	This method is used to validate a build configuration for a build plan

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

init, setTemplateRenderer

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, populateContextForView, prepareConfigObject

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.v2.build.task.BuildTask

init

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

init

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

getEditHtml, getViewHtml

Field Detail

buildLoggerManager

protected BuildLoggerManager buildLoggerManager

Constructor Detail

BuildLabellerCustomBuildProcessor

public BuildLabellerCustomBuildProcessor()

Method Detail

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.

validate

@NotNull
public @NotNull ErrorCollection validate(@NotNull
                                         @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
                                      @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 @NotNull Set<String> getConfigurationKeys()

setCustomVariableContext

public void setCustomVariableContext(CustomVariableContext customVariableContext)

setBuildLoggerManager

public void setBuildLoggerManager(BuildLoggerManager buildLoggerManager)