com.atlassian.bamboo.deployments.configuration

Interface CustomEnvironmentConfigPlugin

All Superinterfaces:

BambooPluginModule

All Known Implementing Classes:

DummyCustomEnvironmentConfig

@ExperimentalApi
public interface CustomEnvironmentConfigPlugin
extends BambooPluginModule

Plugin with custom configuration for each environment. Plugins configuration will be displayed in environment miscellaneous page

Method Summary

Modifier and Type	Method and Description
void	populateContextForEdit(Optional<Map<String,String>> pluginConfig, Map<String,Object> context) Extension point for adding default values to the context for template rendering
void	populateEnvironmentPluginConfig(Map<String,String> pluginConfig, ActionParametersMap parametersMap) Extension point for adding values to environment plugin config map for saving it in database

Method Detail

populateContextForEdit

void populateContextForEdit(@NotNull
                            Optional<Map<String,String>> pluginConfig,
                            @NotNull
                            Map<String,Object> context)

Extension point for adding default values to the context for template rendering

Parameters:

pluginConfig - plugins configuration map Is not present when configuration plugins hasn't yet been saved in database

context - context to populate for template rendering

populateEnvironmentPluginConfig

void populateEnvironmentPluginConfig(@NotNull
                                     Map<String,String> pluginConfig,
                                     @NotNull
                                     ActionParametersMap parametersMap)

Extension point for adding values to environment plugin config map for saving it in database

Parameters:

pluginConfig - environment plugin config map to populate, later saved in database

parametersMap - parameters obtained from environment miscellaneous configuration page