Package io.smallrye.config

Class EnvConfigSource

java.lang.Object

io.smallrye.config.common.AbstractConfigSource

io.smallrye.config.EnvConfigSource

All Implemented Interfaces:

Serializable, org.eclipse.microprofile.config.spi.ConfigSource

public class EnvConfigSource
extends io.smallrye.config.common.AbstractConfigSource

A ConfigSource to access Environment Variables.

A property name matches to an environment variable with the following rules:

1. Match alphanumeric characters (any case)
2. Match non-alphanumeric characters with _
3. Closing quotes in the end of a property name require a double _

Additionally, this implementation provides candidate matching dotted property name from the Environment Variable name. These are required when a consumer relies on the list of properties to find additional configurations. The MicroProfile Config specification defines a set of conversion rules to look up and find values from environment variables even when using their dotted version, but it is unclear about property names.
Because an environment variable name may only be represented by a subset of characters, it is not possible to represent exactly a dotted version name from an environment variable name, so consumers must be aware of such limitations.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final int	ORDINAL

Fields inherited from interface org.eclipse.microprofile.config.spi.ConfigSource

CONFIG_ORDINAL, DEFAULT_ORDINAL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EnvConfigSource()
protected	EnvConfigSource(int ordinal)
	EnvConfigSource(Map<String,String> properties, int ordinal)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getProperties()
Set<String>	getPropertyNames()
String	getValue(String propertyName)

Methods inherited from class io.smallrye.config.common.AbstractConfigSource

getName, getOrdinal, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

ORDINAL

public static final int ORDINAL

See Also:

• Constant Field Values

Constructor Details

EnvConfigSource

protected EnvConfigSource()

EnvConfigSource

protected EnvConfigSource(int ordinal)

EnvConfigSource

public EnvConfigSource(Map<String,String> properties,
 int ordinal)

Method Details

getProperties

public Map<String,String> getProperties()

getPropertyNames

public Set<String> getPropertyNames()

getValue

public String getValue(String propertyName)