com.atlassian.bamboo.plugins.maven.dependencies
Class AutomaticDependencyManagementPlugin

java.lang.Object
  extended by com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
      extended by com.atlassian.bamboo.v2.build.BaseConfigurablePlugin
          extended by com.atlassian.bamboo.plugins.maven.dependencies.AutomaticDependencyManagementPlugin
All Implemented Interfaces:
InitablePluginModule, CustomBuildDefinitionGenerator, CustomBuildDefinitionTransformer, BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, BuildConfigurationUIPlugin, DependenciesBuildConfigurationPlugin, RenderableBuildConfiguration, java.io.Serializable

public class AutomaticDependencyManagementPlugin
extends BaseConfigurablePlugin
implements DependenciesBuildConfigurationPlugin, CustomBuildDefinitionGenerator, java.io.Serializable

See Also:
Serialized Form

Field Summary
static java.lang.String CFG_AUTOMATIC_DEPENDENCY_MANAGEMENT
           
static java.lang.String CFG_AUTOMATIC_DEPENDENCY_MANAGEMENT_ENABLED
           
static java.lang.String CFG_AUTOMATIC_DEPENDENCY_MANAGEMENT_OBJECT
           
static java.lang.String CTX_AUTOMATIC_DEPENDENCY_MANAGEMENT_ENABLED
           
static java.lang.String CTX_DEPENDENCY_PROVIDER_JOB
           
 
Fields inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
moduleDescriptor, templateRenderer
 
Constructor Summary
AutomaticDependencyManagementPlugin()
           
 
Method Summary
static AutomaticDependencyManagementConfig getConfig(BuildDefinition buildDefinition)
           
static AutomaticDependencyManagementConfig getConfig(Plan plan)
           
 boolean isApplicableTo(Plan plan)
          Checks if the plugin is applicable to a plan.
 void populateBuildDefinition(Plan plan, java.util.Map<java.lang.String,java.lang.Object> configObjects, BuildDefinition buildDefinition)
          For Jobs it adds AutomaticDependencyManagementConfig object from a parent plan
protected  void populateContextForEdit(java.util.Map<java.lang.String,java.lang.Object> context, BuildConfiguration buildConfiguration, Plan plan)
           
protected  void populateContextForView(java.util.Map<java.lang.String,java.lang.Object> context, Plan plan)
           
 void transformBuildDefinition(java.util.Map<java.lang.String,java.lang.Object> configObjects, java.util.Map<java.lang.String,java.lang.String> configParameters, BuildDefinition buildDefinition)
          Implementors can add their custom objects to the configObjects map.
 
Methods inherited from class com.atlassian.bamboo.v2.build.BaseConfigurablePlugin
customizeBuildRequirements, customizeBuildRequirements, removeBuildRequirements, removeBuildRequirements
 
Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
addDefaultValues, getEditHtml, getViewHtml, init, isConfigurationMissing, prepareConfigObject, setTemplateRenderer, validate
 
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.configuration.BuildConfigurationUIPlugin
isConfigurationMissing
 
Methods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin
addDefaultValues, prepareConfigObject, validate
 
Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule
init
 
Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration
getEditHtml, getViewHtml
 

Field Detail

CFG_AUTOMATIC_DEPENDENCY_MANAGEMENT_OBJECT

public static final java.lang.String CFG_AUTOMATIC_DEPENDENCY_MANAGEMENT_OBJECT
See Also:
Constant Field Values

CFG_AUTOMATIC_DEPENDENCY_MANAGEMENT

public static final java.lang.String CFG_AUTOMATIC_DEPENDENCY_MANAGEMENT
See Also:
Constant Field Values

CFG_AUTOMATIC_DEPENDENCY_MANAGEMENT_ENABLED

public static final java.lang.String CFG_AUTOMATIC_DEPENDENCY_MANAGEMENT_ENABLED
See Also:
Constant Field Values

CTX_AUTOMATIC_DEPENDENCY_MANAGEMENT_ENABLED

public static final java.lang.String CTX_AUTOMATIC_DEPENDENCY_MANAGEMENT_ENABLED
See Also:
Constant Field Values

CTX_DEPENDENCY_PROVIDER_JOB

public static final java.lang.String CTX_DEPENDENCY_PROVIDER_JOB
See Also:
Constant Field Values
Constructor Detail

AutomaticDependencyManagementPlugin

public AutomaticDependencyManagementPlugin()
Method Detail

isApplicableTo

public boolean isApplicableTo(@NotNull
                              Plan plan)
Description copied from interface: BuildConfigurationUIPlugin
Checks if the plugin is applicable to a plan. Typical implementation is to check plan's type (chain, build, job).

Specified by:
isApplicableTo in interface BuildConfigurationUIPlugin
Parameters:
plan - Plan to be verified
Returns:
true if particular configuration is applicable to input plan

populateContextForView

protected void populateContextForView(@NotNull
                                      java.util.Map<java.lang.String,java.lang.Object> context,
                                      @NotNull
                                      Plan plan)
Overrides:
populateContextForView in class BaseBuildConfigurationAwarePlugin

populateContextForEdit

protected void populateContextForEdit(@NotNull
                                      java.util.Map<java.lang.String,java.lang.Object> context,
                                      @NotNull
                                      BuildConfiguration buildConfiguration,
                                      @NotNull
                                      Plan plan)
Overrides:
populateContextForEdit in class BaseBuildConfigurationAwarePlugin

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
Implementors can add their custom objects to the configObjects map. The key should be unique to plugin... It's better to be descriptive. It is possible to also update the buildDefinition directly, but it's not recommended.

Specified by:
transformBuildDefinition in interface CustomBuildDefinitionTransformer
Parameters:
configObjects - - Map - string key, object value. A map to put custom objects into. @NotNull
configParameters - - Map - String key, string value. These are taken from all fields that begin with "custom."
buildDefinition - - the fully constructed BuildDefinition @NotNull

populateBuildDefinition

public void populateBuildDefinition(@NotNull
                                    Plan plan,
                                    @NotNull
                                    java.util.Map<java.lang.String,java.lang.Object> configObjects,
                                    @NotNull
                                    BuildDefinition buildDefinition)
For Jobs it adds AutomaticDependencyManagementConfig object from a parent plan

Specified by:
populateBuildDefinition in interface CustomBuildDefinitionGenerator
Parameters:
plan - Plan whose BuildDefinition is being populated
configObjects - - Map - string key, object value. A map to put custom objects into. @NotNull
buildDefinition - - the fully constructed BuildDefinition @NotNull

getConfig

@Nullable
public static AutomaticDependencyManagementConfig getConfig(@NotNull
                                                                     Plan plan)

getConfig

@Nullable
public static AutomaticDependencyManagementConfig getConfig(@NotNull
                                                                     BuildDefinition buildDefinition)


Copyright © 2011 Atlassian. All Rights Reserved.