Package org.glassfish.jersey.microprofile.config

Class ConfigurationModel<CONFIG extends org.eclipse.microprofile.config.Config>

java.lang.Object

org.glassfish.jersey.microprofile.config.ConfigurationModel<CONFIG>

Type Parameters:

CONFIG - type of MP configuration impl

All Implemented Interfaces:

Configuration, ExtendedConfig, ExternalConfigurationModel<CONFIG>

public class ConfigurationModel<CONFIG extends org.eclipse.microprofile.config.Config>
extends Object
implements ExternalConfigurationModel<CONFIG>

Generic class which implements default properties provider's logic and wraps not used methods from ExtConfig

Constructor Summary

Constructors

Constructor	Description
ConfigurationModel(CONFIG config)

Method Summary

Modifier and Type	Method	Description
<T> T	as(String name, Class<T> clazz)	Get value of a property as a definite type property shall exist in order for this method to be used.
Set<Class<?>>	getClasses()
CONFIG	getConfig()	Obtain config object
Map<Class<?>,Integer>	getContracts(Class<?> componentClass)
Set<Object>	getInstances()
<T> Optional<T>	getOptionalProperty(String name, Class<T> clazz)	Get value of a property as a definite type property may not exist, an empty Optional object is returned in case of an empty property
Map<String,Object>	getProperties()
Object	getProperty(String name)
Collection<String>	getPropertyNames()
RuntimeType	getRuntimeType()
Object	getValueFromConfig(String name)	Allows ancestors to work with native configuration providers
boolean	isEnabled(Feature feature)
boolean	isEnabled(Class<? extends Feature> featureClass)
boolean	isProperty(String name)	Get the value of the property with a given name converted to boolean.
boolean	isRegistered(Class<?> componentClass)
boolean	isRegistered(Object component)
ExternalConfigurationModel	mergeProperties(Map<String,Object> inputProperties)	Merge properties from other (found) external configuration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.ws.rs.core.Configuration

hasProperty

Constructor Details

ConfigurationModel

public ConfigurationModel(CONFIG config)

Method Details

as

public <T> T as(String name,
 Class<T> clazz)

Description copied from interface: ExternalConfigurationModel

Get value of a property as a definite type property shall exist in order for this method to be used. Otherwise exception is thrown

Specified by:

as in interface ExternalConfigurationModel<CONFIG extends org.eclipse.microprofile.config.Config>

Type Parameters:

T - type of an expected value

Parameters:

name - property name

clazz - class type of an expected value

Returns:

value of an expected type

getOptionalProperty

public <T> Optional<T> getOptionalProperty(String name,
 Class<T> clazz)

Description copied from interface: ExternalConfigurationModel

Get value of a property as a definite type property may not exist, an empty Optional object is returned in case of an empty property

Specified by:

getOptionalProperty in interface ExternalConfigurationModel<CONFIG extends org.eclipse.microprofile.config.Config>

Type Parameters:

T - type of an expected value

Parameters:

name - property name

clazz - class type of an expected value

Returns:

Optional object filled by a value of an expected type or by the NULL value (

getConfig

public CONFIG getConfig()

Description copied from interface: ExternalConfigurationModel

Obtain config object

Specified by:

getConfig in interface ExternalConfigurationModel<CONFIG extends org.eclipse.microprofile.config.Config>

Returns:

external config provider

isProperty

public boolean isProperty(String name)

Description copied from interface: ExtendedConfig

Get the value of the property with a given name converted to boolean. Returns false if the value is not convertible.

Specified by:

isProperty in interface ExtendedConfig

Parameters:

name - property name.

Returns:

boolean property value or false if the property is not convertible.

getValueFromConfig

public Object getValueFromConfig(String name)

Allows ancestors to work with native configuration providers

Parameters:

name - property name

Returns:

property's value if any

getRuntimeType

public RuntimeType getRuntimeType()

Specified by:

getRuntimeType in interface Configuration

getProperties

public Map<String,Object> getProperties()

Specified by:

getProperties in interface Configuration

getProperty

public Object getProperty(String name)

Specified by:

getProperty in interface Configuration

getPropertyNames

public Collection<String> getPropertyNames()

Specified by:

getPropertyNames in interface Configuration

mergeProperties

public ExternalConfigurationModel mergeProperties(Map<String,Object> inputProperties)

Description copied from interface: ExternalConfigurationModel

Merge properties from other (found) external configuration.

Specified by:

mergeProperties in interface ExternalConfigurationModel<CONFIG extends org.eclipse.microprofile.config.Config>

Parameters:

inputProperties - those properties will be merged into ours

Returns:

current instance of the model

isEnabled

public boolean isEnabled(Feature feature)

Specified by:

isEnabled in interface Configuration

isEnabled

public boolean isEnabled(Class<? extends Feature> featureClass)

Specified by:

isEnabled in interface Configuration

isRegistered

public boolean isRegistered(Object component)

Specified by:

isRegistered in interface Configuration

isRegistered

public boolean isRegistered(Class<?> componentClass)

Specified by:

isRegistered in interface Configuration

getContracts

public Map<Class<?>,Integer> getContracts(Class<?> componentClass)

Specified by:

getContracts in interface Configuration

getClasses

public Set<Class<?>> getClasses()

Specified by:

getClasses in interface Configuration

getInstances

public Set<Object> getInstances()

Specified by:

getInstances in interface Configuration