Package io.opentelemetry.sdk.autoconfigure.spi.internal

Class DefaultConfigProperties

java.lang.Object

io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties

All Implemented Interfaces:

ConfigProperties

public final class DefaultConfigProperties
extends Object
implements ConfigProperties

Properties are normalized to The properties for both of these will be normalized to be all lower case, dashses are replaces with periods, and environment variable underscores are replaces with periods.

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,String>	config

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DefaultConfigProperties(DefaultConfigProperties previousProperties, Map<String,String> overrides)
private	DefaultConfigProperties(Map<?,?> systemProperties, Map<String,String> environmentVariables, Map<String,String> defaultProperties)

Method Summary

Modifier and Type	Method	Description
static DefaultConfigProperties	create(Map<String,String> defaultProperties)	Creates a DefaultConfigProperties by merging system properties, environment variables, and the defaultProperties.
static DefaultConfigProperties	createFromMap(Map<String,String> properties)	Create a DefaultConfigProperties from the properties, ignoring system properties and environment variables.
private static List<String>	filterBlanksAndNulls(String[] values)
Boolean	getBoolean(String name)	Returns a boolean-valued configuration property.
Double	getDouble(String name)	Returns a double-valued configuration property.
Duration	getDuration(String name)	Returns a duration property from the map, or null if it cannot be found or it has a wrong type.
private static TimeUnit	getDurationUnit(String unitString)	Returns the TimeUnit associated with a unit string.
Integer	getInt(String name)	Returns an Integer-valued configuration property.
List<String>	getList(String name)	Returns a list-valued configuration property.
Long	getLong(String name)	Returns a Long-valued configuration property.
Map<String,String>	getMap(String name)	Returns a Map configuration property.
static Set<String>	getSet(ConfigProperties config, String name)	Returns ConfigProperties.getList(String) as a Set after validating there are no duplicate entries.
String	getString(String name)	Returns a string-valued configuration property.
private static String	getUnitString(String rawValue)	Fragments the 'units' portion of a config value from the 'value' portion.
private static ConfigurationException	newInvalidPropertyException(String name, String value, String type)
DefaultConfigProperties	withOverrides(Map<String,String> overrides)	Return a new DefaultConfigProperties by overriding the previousProperties with the overrides.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties

getBoolean, getDouble, getDuration, getInt, getList, getLong, getMap, getString

Field Details

config

private final Map<String,String> config

Constructor Details

DefaultConfigProperties

private DefaultConfigProperties(Map<?,?> systemProperties,
 Map<String,String> environmentVariables,
 Map<String,String> defaultProperties)

DefaultConfigProperties

private DefaultConfigProperties(DefaultConfigProperties previousProperties,
 Map<String,String> overrides)

Method Details

create

public static DefaultConfigProperties create(Map<String,String> defaultProperties)

Creates a DefaultConfigProperties by merging system properties, environment variables, and the defaultProperties.

Environment variables take priority over defaultProperties. System properties take priority over environment variables.

createFromMap

public static DefaultConfigProperties createFromMap(Map<String,String> properties)

Create a DefaultConfigProperties from the properties, ignoring system properties and environment variables.

getString

@Nullable
public String getString(String name)

Description copied from interface: ConfigProperties

Returns a string-valued configuration property.

Specified by:

getString in interface ConfigProperties

Returns:

null if the property has not been configured.

getBoolean

@Nullable
public Boolean getBoolean(String name)

Description copied from interface: ConfigProperties

Returns a boolean-valued configuration property. Implementations should use the same rules as Boolean.parseBoolean(String) for handling the values.

Specified by:

getBoolean in interface ConfigProperties

Returns:

null if the property has not been configured.

getInt

@Nullable
public Integer getInt(String name)

Description copied from interface: ConfigProperties

Returns an Integer-valued configuration property.

Specified by:

getInt in interface ConfigProperties

Returns:

null if the property has not been configured.

getLong

@Nullable
public Long getLong(String name)

Description copied from interface: ConfigProperties

Returns a Long-valued configuration property.

Specified by:

getLong in interface ConfigProperties

Returns:

null if the property has not been configured.

getDouble

@Nullable
public Double getDouble(String name)

Description copied from interface: ConfigProperties

Returns a double-valued configuration property.

Specified by:

getDouble in interface ConfigProperties

Returns:

null if the property has not been configured.

getDuration

@Nullable
public Duration getDuration(String name)

Description copied from interface: ConfigProperties

Returns a duration property from the map, or null if it cannot be found or it has a wrong type.

Durations can be of the form "{number}{unit}", where unit is one of:

• ms
• s
• m
• h
• d

If no unit is specified, milliseconds is the assumed duration unit.

Specified by:

getDuration in interface ConfigProperties

Parameters:

name - The property name

Returns:

the Duration value of the property, null if the property cannot be found.

getList

public List<String> getList(String name)

Description copied from interface: ConfigProperties

Returns a list-valued configuration property. The format of the original value must be comma-separated. Empty values will be removed.

Specified by:

getList in interface ConfigProperties

Returns:

an empty list if the property has not been configured.

getSet

public static Set<String> getSet(ConfigProperties config,
 String name)

Returns ConfigProperties.getList(String) as a Set after validating there are no duplicate entries.

Throws:

ConfigurationException - if name contains duplicate entries

getMap

public Map<String,String> getMap(String name)

Description copied from interface: ConfigProperties

Returns a Map configuration property. The format of the original value must be comma-separated for each key, with an '=' separating the key and value. For instance, service.name=Greatest Service,host.name=localhost. Empty values will be removed.

Specified by:

getMap in interface ConfigProperties

Returns:

an empty map if the property has not been configured.

withOverrides

public DefaultConfigProperties withOverrides(Map<String,String> overrides)

Return a new DefaultConfigProperties by overriding the previousProperties with the overrides.

newInvalidPropertyException

private static ConfigurationException newInvalidPropertyException(String name,
 String value,
 String type)

filterBlanksAndNulls

private static List<String> filterBlanksAndNulls(String[] values)

getDurationUnit

private static TimeUnit getDurationUnit(String unitString)

Returns the TimeUnit associated with a unit string. Defaults to milliseconds.

getUnitString

private static String getUnitString(String rawValue)

Fragments the 'units' portion of a config value from the 'value' portion.

E.g. "1ms" would return the string "ms".