public interface Config
ConfigSources. If the same
property is specified in multiple ConfigSources, the value in the ConfigSource with the
highest ordinal will be used.
If multiple ConfigSources are specified with the same ordinal, the
ConfigSource.getName() will be used for sorting.
The config objects produced via the injection model @Inject Config are guaranteed to be serializable, while
the programmatically created ones are not required to be serializable.
If one or more converters are registered for a class of a requested value then the registered
Converter which has the highest @jakarta.annotation.Priority is
used to convert the string value retrieved from the config sources.
For accessing the config you can use the ConfigProvider:
public void doSomething() {
Config cfg = ConfigProvider.getConfig();
String archiveUrl = cfg.getValue("my.project.archive.endpoint", String.class);
Integer archivePort = cfg.getValue("my.project.archive.port", Integer.class);
}
It is also possible to inject the Config if a DI container is available:
public class MyService {
@Inject
private Config config;
}
See getValue(String, Class) and getOptionalValue(String, Class) for accessing a configured value.
Configured values can also be accessed via injection. See
ConfigProperty for more information.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
PROFILE
The value of the property specifies a single active profile.
|
static java.lang.String |
PROPERTY_EXPRESSIONS_ENABLED
The value of the property determines whether the property expression is enabled or disabled.
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.Iterable<ConfigSource> |
getConfigSources()
Return all of the currently registered configuration sources for this configuration.
|
ConfigValue |
getConfigValue(java.lang.String propertyName)
Return the
ConfigValue for the specified property name from the underlying configuration source. |
<T> java.util.Optional<Converter<T>> |
getConverter(java.lang.Class<T> forType)
Return the
Converter used by this instance to produce instances of the specified type from string values. |
<T> java.util.Optional<T> |
getOptionalValue(java.lang.String propertyName,
java.lang.Class<T> propertyType)
Return the resolved property value with the specified type for the specified property name from the underlying
configuration sources.
|
default <T> java.util.Optional<java.util.List<T>> |
getOptionalValues(java.lang.String propertyName,
java.lang.Class<T> propertyType)
Return the resolved property values with the specified type for the specified property name from the underlying
configuration sources.
|
java.lang.Iterable<java.lang.String> |
getPropertyNames()
Returns a sequence of configuration property names.
|
<T> T |
getValue(java.lang.String propertyName,
java.lang.Class<T> propertyType)
Return the resolved property value with the specified type for the specified property name from the underlying
configuration sources.
|
default <T> java.util.List<T> |
getValues(java.lang.String propertyName,
java.lang.Class<T> propertyType)
Return the resolved property values with the specified type for the specified property name from the underlying
configuration sources.
|
<T> T |
unwrap(java.lang.Class<T> type)
Returns an instance of the specific class, to allow access to the provider specific API.
|
static final java.lang.String PROFILE
static final java.lang.String PROPERTY_EXPRESSIONS_ENABLED
false means the property expression is disabled, while true means enabled.
By default, the value is set to true.<T> T getValue(java.lang.String propertyName,
java.lang.Class<T> propertyType)
The configuration value is not guaranteed to be cached by the implementation, and may be expensive to compute; therefore, if the returned value is intended to be frequently used, callers should consider storing rather than recomputing it.
The result of this method is identical to the result of calling
getOptionalValue(propertyName, propertyType).get(). In particular, If the given property name or the
value element of this property does not exist, the NoSuchElementException is thrown. This
method never returns null.
T - The property typepropertyName - The configuration property namepropertyType - The type into which the resolved property value should get convertednull)java.lang.IllegalArgumentException - if the property cannot be converted to the specified typejava.util.NoSuchElementException - if the property is not defined or is defined as an empty string or the converter returns nullConfigValue getConfigValue(java.lang.String propertyName)
ConfigValue for the specified property name from the underlying configuration source. The lookup of the configuration is performed immediately, meaning that calls to
ConfigValue will always yield the same results.
The configuration value is not guaranteed to be cached by the implementation, and may be expensive to compute; therefore, if the returned value is intended to be frequently used, callers should consider storing rather than recomputing it.
A ConfigValue is always returned even if a property name cannot be found. In this case, every method in
ConfigValue returns null except for ConfigValue.getName(), which includes the original
property name being looked up.
propertyName - The configuration property nameConfigValuedefault <T> java.util.List<T> getValues(java.lang.String propertyName,
java.lang.Class<T> propertyType)
The configuration values are not guaranteed to be cached by the implementation, and may be expensive to compute; therefore, if the returned values are intended to be frequently used, callers should consider storing rather than recomputing them.
T - The property typepropertyName - The configuration property namepropertyType - The type into which the resolved property values should get convertedjava.lang.IllegalArgumentException - if the property values cannot be converted to the specified typejava.util.NoSuchElementException - if the property isn't present in the configuration or is defined as an empty string or the converter
returns null<T> java.util.Optional<T> getOptionalValue(java.lang.String propertyName,
java.lang.Class<T> propertyType)
The configuration value is not guaranteed to be cached by the implementation, and may be expensive to compute; therefore, if the returned value is intended to be frequently used, callers should consider storing rather than recomputing it.
If this method is used very often then consider to locally store the configured value.
T - The property typepropertyName - The configuration property namepropertyType - The type into which the resolved property value should be convertedOptional wrapping the requested typejava.lang.IllegalArgumentException - if the property cannot be converted to the specified typedefault <T> java.util.Optional<java.util.List<T>> getOptionalValues(java.lang.String propertyName,
java.lang.Class<T> propertyType)
The configuration values are not guaranteed to be cached by the implementation, and may be expensive to compute; therefore, if the returned values are intended to be frequently used, callers should consider storing rather than recomputing them.
T - The property typepropertyName - The configuration property namepropertyType - The type into which the resolved property values should be convertedOptional wrapping a list of the requested typejava.lang.IllegalArgumentException - if the property cannot be converted to the specified typejava.lang.Iterable<java.lang.String> getPropertyNames()
The returned property names are unique; that is, if a name is returned once by a given iteration, it will not be returned again during that same iteration.
There is no guarantee about the completeness or currency of the names returned, nor is there any guarantee that a name that is returned by the iterator will resolve to a non-empty value or be found in any configuration source associated with the configuration; for example, it is allowed for this method to return an empty set always. However, the implementation should return a set of names that is useful to a user that wishes to browse the configuration.
It is implementation-defined whether the returned names reflect a point-in-time "snapshot" of names, or an
aggregation of multiple point-in-time "snapshots", or a more dynamic view of the available property names.
Implementations are not required to return the same sequence of names on each iteration; however, the produced
Iterator must adhere to the contract of that class, and must not return any more
elements once its hasNext() method returns false.
The returned instance is thread safe and may be iterated concurrently. The individual iterators are not thread-safe.
java.lang.Iterable<ConfigSource> getConfigSources()
The returned sources will be sorted by descending ordinal value and name, which can be iterated in a thread-safe
manner. The Iterable contains a fixed number of configuration
sources, determined at application start time, and the config sources themselves may be static or dynamic.
<T> java.util.Optional<Converter<T>> getConverter(java.lang.Class<T> forType)
Converter used by this instance to produce instances of the specified type from string values.T - the conversion typeforType - the type to be produced by the converterOptional containing the converter, or empty if no converter is available for the specified
type<T> T unwrap(java.lang.Class<T> type)
If the MP Config provider implementation does not support the specified class, a IllegalArgumentException
is thrown.
Unwrapping to the provider specific API may lead to non-portable behaviour.
T - The type to unwrap totype - Class representing the type to unwrap tojava.lang.IllegalArgumentException - If the current provider does not support unwrapping to the given type