Class ConcurrentBuildsPlanConfigurationPlugin
java.lang.Object
com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
com.atlassian.bamboo.build.configuration.ConcurrentBuildsPlanConfigurationPlugin
- All Implemented Interfaces:
MiscellaneousPlanConfigurationPlugin,PlanConfigurationUiPlugin,InitablePluginModule,BambooPluginModule,BuildConfigurationAwarePlugin,ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds,,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties> RenderableBuildConfiguration
public class ConcurrentBuildsPlanConfigurationPlugin
extends BaseBuildConfigurationAwarePlugin
implements MiscellaneousPlanConfigurationPlugin, ImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final StringFields inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
moduleDescriptor, templateRenderer -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddToBuildConfiguration(@NotNull com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties specsProperties, @NotNull org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration) Validate and add data from specs properties to passed build configuration.@Nullable com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuildsImport configuration of this plugin from YAML node to Bamboo Specs entity.Return all property keys related to this plugin module which may exist in a plan'sBuildConfiguration.booleanisApplicableTo(@NotNull ImmutablePlan plan) Checks if the plugin is applicable to a plan.protected voidpopulateContextForView(@NotNull Map<String, Object> context, @NotNull Plan plan) voidsetAdministrationConfigurationAccessor(AdministrationConfigurationAccessor administrationConfigurationAccessor) voidsetTextProvider(com.opensymphony.xwork2.TextProvider textProvider) @NotNull com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuildstoSpecsEntity(@NotNull org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration) Export configuration of this plugin to Bamboo Specs entity.@Nullable NodetoYaml(@NotNull com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties specsProperties) Convert configuration of this plugin from Bamboo Specs to YAML structure.@NotNull ErrorCollectionvalidate(@NotNull BuildConfiguration buildConfiguration) Validates the properties in theBuildConfigurationobject.Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
addDefaultValues, getEditHtml, getTemplateRenderer, getViewHtml, init, populateContextForEdit, prepareConfigObject, setTemplateRendererMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin
addDefaultValues, isConfigurationMissing, prepareConfigObjectMethods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule
initMethods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration
getEditHtml, getViewHtml
-
Field Details
-
CONCURRENT_BUILD_OBJECT_KEY
- See Also:
-
NUMBER_CONCURRENT_BUILDS_OVERRIDE
- See Also:
-
NUMBER_CONCURRENT_BUILDS
- See Also:
-
CONCURRENT_BUILDS_STRATEGY
- See Also:
-
-
Constructor Details
-
ConcurrentBuildsPlanConfigurationPlugin
public ConcurrentBuildsPlanConfigurationPlugin()
-
-
Method Details
-
populateContextForView
protected void populateContextForView(@NotNull @NotNull Map<String, Object> context, @NotNull @NotNull Plan plan) - Overrides:
populateContextForViewin classBaseBuildConfigurationAwarePlugin
-
validate
@NotNull public @NotNull ErrorCollection validate(@NotNull @NotNull BuildConfiguration buildConfiguration) Description copied from interface:BuildConfigurationAwarePluginValidates the properties in theBuildConfigurationobject. The name of the properties match those passed in through the form fragments inRenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)template.- Specified by:
validatein interfaceBuildConfigurationAwarePlugin- Overrides:
validatein classBaseBuildConfigurationAwarePlugin- Parameters:
buildConfiguration- -- Returns:
ErrorCollectionkeyed by the field name.
-
isApplicableTo
Description copied from interface:PlanConfigurationUiPluginChecks if the plugin is applicable to a plan. Typical implementation is to check plan's type (chain, build, job).- Specified by:
isApplicableToin interfacePlanConfigurationUiPlugin- Parameters:
plan- Plan to be verified- Returns:
- true if particular configuration is applicable to input plan
-
toSpecsEntity
@NotNull public @NotNull com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds toSpecsEntity(@NotNull @NotNull org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration) Description copied from interface:ImportExportAwarePluginExport configuration of this plugin to Bamboo Specs entity.- Specified by:
toSpecsEntityin interfaceImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>
-
addToBuildConfiguration
public void addToBuildConfiguration(@NotNull @NotNull com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties specsProperties, @NotNull @NotNull org.apache.commons.configuration.HierarchicalConfiguration buildConfiguration) Description copied from interface:ImportExportAwarePluginValidate and add data from specs properties to passed build configuration.- Specified by:
addToBuildConfigurationin interfaceImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>
-
toYaml
@Nullable public @Nullable Node toYaml(@NotNull @NotNull com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties specsProperties) Description copied from interface:ImportExportAwarePluginConvert configuration of this plugin from Bamboo Specs to YAML structure.- Specified by:
toYamlin interfaceImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties> - Returns:
- YAML
Nodecontaining representation of Bamboo Specs entity.
-
fromYaml
@Nullable public @Nullable com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds fromYaml(@NotNull @NotNull Node node) throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException Description copied from interface:ImportExportAwarePluginImport configuration of this plugin from YAML node to Bamboo Specs entity.- Specified by:
fromYamlin interfaceImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties> - Parameters:
node- yaml node- Returns:
- Bamboo Specs entity for plugin settings.
- Throws:
com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException- if configuration is wrong.
-
getConfigurationKeys
Description copied from interface:ImportExportAwarePluginReturn all property keys related to this plugin module which may exist in a plan'sBuildConfiguration.The returned set may be immutable. If a plugin module doesn't have configuration, then an empty set should be returned.
- Specified by:
getConfigurationKeysin interfaceImportExportAwarePlugin<com.atlassian.bamboo.specs.api.builders.plan.configuration.ConcurrentBuilds,com.atlassian.bamboo.specs.api.model.plan.configuration.ConcurrentBuildsProperties>
-
setAdministrationConfigurationAccessor
public void setAdministrationConfigurationAccessor(AdministrationConfigurationAccessor administrationConfigurationAccessor) -
setTextProvider
public void setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)
-