io.github.amyassist.amy.core.configuration

Interface EnvironmentConfigurationLoader

public interface EnvironmentConfigurationLoader

A configuration loader that will load configurations from the environment variables. Changes can't be stored with this ConfigurationLoader.

The name schema for the environment variables is AMY_<config name>_<property key>.

All '.'s in the config name are replaced with '_'. The matching is done case insensitive.

A environment variable must match "[a-zA-Z_][a-zA-Z0-9_]*", so <config name>_<property key> must as well for a configuration to be read from the environment.

Author:

Tim Neumann

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOWED_ENV_VARS_PATTERN The patter for allowed environment variables.

Method Summary

Modifier and Type	Method and Description
boolean	isAllowedName(String name) Checks whether the given string is an allowed name for configurations to load from the environment.
Properties	load(String configurationName, Properties original) Load all properties set in the given original from the environment variables.

Field Detail

ALLOWED_ENV_VARS_PATTERN

static final String ALLOWED_ENV_VARS_PATTERN

The patter for allowed environment variables.

See Also:

Constant Field Values

Method Detail

load

@Nonnull
Properties load(String configurationName,
                          @Nonnull
                          Properties original)

Load all properties set in the given original from the environment variables.

This method will only load these properties that are also set in the original or its defaults recursivly.

Parameters:

configurationName - the name of the config.

original - A property file containing settings.

Returns:

A new Properties object with the original Properties set as the defaults and the properties from the environment.

Throws:

IllegalArgumentException - When the configuration name is not a legal environment variable name. See EnvironmentConfigurationLoader.

isAllowedName

boolean isAllowedName(String name)

Checks whether the given string is an allowed name for configurations to load from the environment.

Parameters:

name - The name to check.

Returns:

Whether the name is allowed.