com.atlassian.bamboo.v2.build
Class BaseConfigurablePlugin

java.lang.Object
  extended by com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
      extended by com.atlassian.bamboo.v2.build.BaseConfigurablePlugin
All Implemented Interfaces:
InitablePluginModule, BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, RenderableBuildConfiguration
Direct Known Subclasses:
AbstractRepository, AbstractWebRepositoryViewer, ArtifactHandlerForPlanConfigurator, AutomaticDependencyManagementPlugin, BaseConfigurableBuildPlugin, BrokenBuildConfiguration, BrokenBuildPostProcessor, BuildExpiryPerPlanPlugin, BuildLabeller, BuildMonitoringPerPlanPlugin

public abstract class BaseConfigurablePlugin
extends BaseBuildConfigurationAwarePlugin
implements ConfigurablePlugin

Skeleton class which should be extended by implementors of ConfigurablePlugin interface.


Field Summary
 
Fields inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
moduleDescriptor, templateRenderer
 
Constructor Summary
BaseConfigurablePlugin()
           
 
Method Summary
 void customizeBuildRequirements(BuildConfiguration buildConfiguration, RequirementSet requirementSet)
          Deprecated. since 3.0 Use #customizeBuildRequirements(Plan, BuildConfiguration, RequirementSet)
 void customizeBuildRequirements(PlanKey planKey, BuildConfiguration buildConfiguration, RequirementSet requirementSet)
          Extension point for adding/customizing requirements when editing a build's builder configuration.
 void removeBuildRequirements(BuildConfiguration buildConfiguration, RequirementSet requirementSet)
          Deprecated. since 3.0 Use #removeBuildRequirements(Plan, BuildConfiguration, RequirementSet)
 void removeBuildRequirements(PlanKey planKey, BuildConfiguration buildConfiguration, RequirementSet requirementSet)
          Extension point for removing requirements when given plugin is excluded from build's builder configuration.
 
Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
addDefaultValues, getEditHtml, getViewHtml, init, isConfigurationMissing, populateContextForEdit, populateContextForView, 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.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
 

Constructor Detail

BaseConfigurablePlugin

public BaseConfigurablePlugin()
Method Detail

customizeBuildRequirements

public void customizeBuildRequirements(@NotNull
                                       PlanKey planKey,
                                       @NotNull
                                       BuildConfiguration buildConfiguration,
                                       @NotNull
                                       RequirementSet requirementSet)
Description copied from interface: ConfigurablePlugin
Extension point for adding/customizing requirements when editing a build's builder configuration.

Specified by:
customizeBuildRequirements in interface ConfigurablePlugin
Parameters:
planKey - key of Plan for which requirements has to be removed.
buildConfiguration - source of information for customizing build requirements
requirementSet - requirements to be customized

customizeBuildRequirements

@Deprecated
public void customizeBuildRequirements(@NotNull
                                                  BuildConfiguration buildConfiguration,
                                                  @NotNull
                                                  RequirementSet requirementSet)
Deprecated. since 3.0 Use #customizeBuildRequirements(Plan, BuildConfiguration, RequirementSet)


removeBuildRequirements

public void removeBuildRequirements(@NotNull
                                    PlanKey planKey,
                                    @NotNull
                                    BuildConfiguration buildConfiguration,
                                    @NotNull
                                    RequirementSet requirementSet)
Description copied from interface: ConfigurablePlugin
Extension point for removing requirements when given plugin is excluded from build's builder configuration.

Specified by:
removeBuildRequirements in interface ConfigurablePlugin
Parameters:
planKey - key of Plan for which requirements has to be removed.
buildConfiguration - source of information for customizing build requirements
requirementSet - requirements to be customized

removeBuildRequirements

@Deprecated
public void removeBuildRequirements(@NotNull
                                               BuildConfiguration buildConfiguration,
                                               @NotNull
                                               RequirementSet requirementSet)
Deprecated. since 3.0 Use #removeBuildRequirements(Plan, BuildConfiguration, RequirementSet)



Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.