Package com.atlassian.bamboo.deployments.configuration.service

Interface EnvironmentCustomConfigService

All Known Implementing Classes:

EnvironmentCustomConfigServiceImpl

@ExperimentalApi
public interface EnvironmentCustomConfigService

Provides services and functionality around custom configuration of Environments.

Method Summary

Modifier and Type	Method	Description
@NotNull DockerPipelineConfiguration	getDockerPipelineConfiguration(long environmentId)	Returns Docker pipeline configuration for a particular environment.
@NotNull Map<String,Map<String,String>>	getEnvironmentPluginConfig(long environmentId)	Returns plugins configuration map of given environment.
void	saveDockerPipelineConfiguration(@NotNull DockerPipelineConfiguration dockerPipelineConfiguration, long environmentId)	Set Docker pipeline configuration for a particular environment.
void	saveEnvironmentPluginConfig(@Nullable Map<String,Map<String,String>> config, long environmentId)	Saves plugins config for given environment.

Method Detail

getEnvironmentPluginConfig

@NotNull
@NotNull Map<String,Map<String,String>> getEnvironmentPluginConfig(long environmentId)

Returns plugins configuration map of given environment.

Parameters:

environmentId - ID of the environment

Returns:

configuration map, with one entry per plugin

Throws:

IllegalArgumentException - if environment with the given ID can't be found

saveEnvironmentPluginConfig

void saveEnvironmentPluginConfig(@Nullable
                                 @Nullable Map<String,Map<String,String>> config,
                                 long environmentId)

Saves plugins config for given environment.

Parameters:

config - plugins configuration map, with one entry per plugin

environmentId - ID of the environment

Throws:

IllegalArgumentException - if environment with the given ID can't be found

getDockerPipelineConfiguration

@NotNull
@NotNull DockerPipelineConfiguration getDockerPipelineConfiguration(long environmentId)

Returns Docker pipeline configuration for a particular environment.

Parameters:

environmentId - ID of the environment

Throws:

IllegalArgumentException - if environment with the given ID can't be found

saveDockerPipelineConfiguration

void saveDockerPipelineConfiguration(@NotNull
                                     @NotNull DockerPipelineConfiguration dockerPipelineConfiguration,
                                     long environmentId)

Set Docker pipeline configuration for a particular environment.

Parameters:

dockerPipelineConfiguration - configuration of docker pipeline

environmentId - ID of the environment

Throws:

IllegalArgumentException - if environment with the given ID can't be found