Module org.glassfish.jersey.core.common

Package org.glassfish.jersey.internal.config

Class SystemPropertiesConfigurationModel

java.lang.Object

org.glassfish.jersey.internal.config.SystemPropertiesConfigurationModel

All Implemented Interfaces:

Configuration, ExtendedConfig, ExternalConfigurationModel<Void>

public class SystemPropertiesConfigurationModel
extends Object
implements ExternalConfigurationModel<Void>

The External Configuration Model that supports System properties. The properties are listed in a property class in a form of public static final String property name. The String value of the property name is searched among the System properties. The property scan is performed only when CommonProperties.ALLOW_SYSTEM_PROPERTIES_PROVIDER is set to true.

Constructor Summary

Constructors

Constructor	Description
SystemPropertiesConfigurationModel(List<String> propertyClassNames)	Create new ExternalConfigurationModel for properties defined by classes in propertyClassNames list.

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()
Void	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)
protected List<String>	getPropertyClassNames()
Collection<String>	getPropertyNames()
RuntimeType	getRuntimeType()
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

SystemPropertiesConfigurationModel

public SystemPropertiesConfigurationModel(List<String> propertyClassNames)

Create new ExternalConfigurationModel for properties defined by classes in propertyClassNames list.

Parameters:

propertyClassNames - List of property defining class names.

Method Details

getPropertyClassNames

protected List<String> getPropertyClassNames()

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<Void>

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<Void>

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 (

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<Void>

Parameters:

inputProperties - those properties will be merged into ours

Returns:

current instance of the model

getConfig

public Void getConfig()

Description copied from interface: ExternalConfigurationModel

Obtain config object

Specified by:

getConfig in interface ExternalConfigurationModel<Void>

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.

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

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