io.smallrye.config

Class EnvConfigSource

java.lang.Object

io.smallrye.config.EnvConfigSource

All Implemented Interfaces:

Serializable, ConfigSource

public class EnvConfigSource
extends Object
implements ConfigSource, Serializable

Author:

Jeff Mesnil (c) 2017 Red Hat inc.

See Also:

Serialized Form

Field Summary

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

CONFIG_ORDINAL, DEFAULT_ORDINAL

Method Summary

Modifier and Type	Method and Description
String	getName() The name of the config might be used for logging or analysis of configured values.
int	getOrdinal() Return the ordinal for this config source.
Map<String,String>	getProperties() Return the properties in this config source
String	getValue(String name) Return the value for the specified property in this config source.

Methods inherited from class java.lang.Object

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

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

getPropertyNames

Method Detail

getProperties

public Map<String,String> getProperties()

Description copied from interface: ConfigSource

Return the properties in this config source

Specified by:

getProperties in interface ConfigSource

Returns:

the map containing the properties in this config source

getOrdinal

public int getOrdinal()

Description copied from interface: ConfigSource

Return the ordinal for this config source. If a property is specified in multiple config sources, the value in the config source with the highest ordinal takes precedence. For the config sources with the same ordinal value, the config source names will be used for sorting according to string sorting criteria. Note that this property only gets evaluated during ConfigSource discovery. The default ordinals for the default config sources:

1. System properties (ordinal=400)
2. Environment properties (ordinal=300)

   Some operating systems allow only alphabetic characters or an underscore(_), in environment variables. Other characters such as ., /, etc may be disallowed. In order to set a value for a config property that has a name containing such disallowed characters from an environment variable, the following rules are used. This ConfigSource searches for potentially 3 environment variables with a given property name (e.g. "com.ACME.size"):

   1. Exact match (i.e. "com.ACME.size")
   2. Replace the character that is neither alphanumeric nor '_' with '_' (i.e. "com_ACME_size")
   3. Replace the character that is neither alphanumeric nor '_' with '_' and convert to upper case (i.e. "COM_ACME_SIZE")

   The first environment variable that is found is returned by this ConfigSource.

3. /META-INF/microprofile-config.properties (default ordinal=100)

Any ConfigSource part of an application will typically use an ordinal between 0 and 200. ConfigSource provided by the container or 'environment' typically use an ordinal higher than 200. A framework which intends have values overwritten by the application will use ordinals between 0 and 100. The property "config_ordinal" can be specified to override the default value.

Specified by:

getOrdinal in interface ConfigSource

Returns:

the ordinal value

getValue

public String getValue(String name)

Description copied from interface: ConfigSource

Return the value for the specified property in this config source.

Specified by:

getValue in interface ConfigSource

Parameters:

name - the property name

Returns:

the property value

getName

public String getName()

Description copied from interface: ConfigSource

The name of the config might be used for logging or analysis of configured values.

Specified by:

getName in interface ConfigSource

Returns:

the 'name' of the configuration source, e.g. 'property-file mylocation/myproperty.properties'