Package com.atlassian.bamboo.build

Interface BuildTriggerCondition

All Superinterfaces:

BambooPluginModule, BuildConfigurationAwarePlugin, InitablePluginModule, RenderableBuildConfiguration

All Known Implementing Classes:

PlansGreenCondition

public interface BuildTriggerCondition
extends BuildConfigurationAwarePlugin

Provides the ability to gate whether a build should be triggered or not. Uses a preference system so plugins can behave nicer with each other.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BuildTriggerCondition.ExecutionPreference

Method Summary

Modifier and Type	Method	Description
@NotNull Map<String,String>	getConfigurationMap(@NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)	This method should extract entire configuration of this plugin from HierarchicalConfiguration and return it as map.
@NotNull BuildTriggerCondition.ExecutionPreference	getExecutionPreference(ImmutablePlan plan, Map<String,String> configuration)	Use to indicate preference for whether this plugin things the plan should execute.

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

addDefaultValues, isConfigurationMissing, prepareConfigObject, validate

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

init

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

getEditHtml, getViewHtml

Method Detail

getConfigurationMap

@NotNull
@NotNull Map<String,String> getConfigurationMap(@NotNull
                                                      @NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)

This method should extract entire configuration of this plugin from HierarchicalConfiguration and return it as map.

Parameters:

configuration - a configuration

Returns:

complete configuration of the plugin as a string map

Since:

4.3

getExecutionPreference

@NotNull
@NotNull BuildTriggerCondition.ExecutionPreference getExecutionPreference(ImmutablePlan plan,
                                                                          Map<String,String> configuration)

Use to indicate preference for whether this plugin things the plan should execute. Whether the build actually will execute will follow the above order

Parameters:

plan - the plan that will be executed

configuration - of the plugin as returned by getConfigurationMap(HierarchicalConfiguration)

Returns:

the execution preference of this plan, will be overridden if another plugin returns with a higher preference

Since:

4.3