org.glassfish.jersey.internal.util

Class PropertiesHelper

java.lang.Object

org.glassfish.jersey.internal.util.PropertiesHelper

public final class PropertiesHelper
extends Object

Helper class containing convenience methods for reading org.glassfish.jersey.server.ResourceConfig and Configuration properties.

Author:

Martin Matula

Method Summary

Modifier and Type	Method and Description
static <T> T	convertValue(Object value, Class<T> type) Convert Object value to a value of the specified class type.
static String	getPropertyNameForRuntime(String key, RuntimeType runtimeType) Returns specific property value for given RuntimeType.
static PrivilegedAction<Properties>	getSystemProperties() Get system properties.
static PrivilegedAction<String>	getSystemProperty(String name) Get system property.
static PrivilegedAction<String>	getSystemProperty(String name, String def) Get system property.
static <T> T	getValue(Map<String,?> properties, RuntimeType runtimeType, String key, Class<T> type, Map<String,String> legacyMap) Returns value of a specified property.
static <T> T	getValue(Map<String,?> properties, RuntimeType runtimeType, String key, T defaultValue, Class<T> type, Map<String,String> legacyMap) Returns value of a specified property.
static <T> T	getValue(Map<String,?> properties, RuntimeType runtimeType, String key, T defaultValue, Map<String,String> legacyMap) Return value of a specified property.
static <T> T	getValue(Map<String,?> properties, String key, Class<T> type, Map<String,String> legacyMap) Returns value of a specified property.
static <T> T	getValue(Map<String,?> properties, String key, T defaultValue, Class<T> type, Map<String,String> legacyMap) Returns value of a specified property.
static <T> T	getValue(Map<String,?> properties, String key, T defaultValue, Map<String,String> legacyMap) Return value of a specified property.
static boolean	isJaxRsServiceLoadingEnabled(Map<String,Object> properties) Check whether loading of JAX-RS services is allowed or not.
static boolean	isMetaInfServicesEnabled(Map<String,Object> properties, RuntimeType runtimeType) Determine whether CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE does not globally disable META-INF/services lookup on client/server.
static boolean	isProperty(Map<String,Object> properties, String name) Get the value of the property with a given name converted to boolean.
static boolean	isProperty(Object value) Get the value of the property converted to boolean.
static boolean	isPropertyOrNotSet(Object value) Converts the property value to boolean and checks it is true or empty.

Methods inherited from class java.lang.Object

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

Method Detail

getSystemProperties

public static PrivilegedAction<Properties> getSystemProperties()

Get system properties. This method delegates to System.getProperties() while running it in a privileged code block.

Returns:

privileged action to obtain system properties.

getSystemProperty

public static PrivilegedAction<String> getSystemProperty(String name)

Get system property. This method delegates to System.getProperty(String) while running it in a privileged code block.

Parameters:

name - system property name.

Returns:

privileged action to obtain system property value that will return null if there's no such system property.

getSystemProperty

public static PrivilegedAction<String> getSystemProperty(String name,
                                                         String def)

Get system property. This method delegates to System.getProperty(String) while running it in a privileged code block.

Parameters:

name - system property name.

def - default property value.

Returns:

privileged action to obtain system property value that will return the default value if there's no such system property.

getValue

public static <T> T getValue(Map<String,?> properties,
                             String key,
                             T defaultValue,
                             Map<String,String> legacyMap)

Return value of a specified property. If the property is not set or the real value type is not compatible with defaultValue type, the specified defaultValue is returned. Calling this method is equivalent to calling PropertyHelper.getValue(properties, key, defaultValue, (Class<T>) defaultValue.getClass())

Type Parameters:

T - Type of the property value.

Parameters:

properties - Map of properties to get the property value from.

key - Name of the property.

defaultValue - Default value to be returned if the specified property is not set or cannot be read.

legacyMap - Legacy fallback map, where key is the actual property name, value is the old property name

Returns:

Value of the property or defaultValue.

getValue

public static <T> T getValue(Map<String,?> properties,
                             RuntimeType runtimeType,
                             String key,
                             T defaultValue,
                             Map<String,String> legacyMap)

Return value of a specified property. If the property is not set or the real value type is not compatible with defaultValue type, the specified defaultValue is returned. Calling this method is equivalent to calling PropertyHelper.getValue(properties, runtimeType, key, defaultValue, (Class<T>) defaultValue.getClass())

Type Parameters:

T - Type of the property value.

Parameters:

properties - Map of properties to get the property value from.

runtimeType - Runtime type which is used to check whether there is a property with the same key but post-fixed by runtime type (.server or .client) which would override the key property.

key - Name of the property.

defaultValue - Default value to be returned if the specified property is not set or cannot be read.

legacyMap - Legacy fallback map, where key is the actual property name, value is the old property name

Returns:

Value of the property or defaultValue.

getValue

public static <T> T getValue(Map<String,?> properties,
                             String key,
                             T defaultValue,
                             Class<T> type,
                             Map<String,String> legacyMap)

Returns value of a specified property. If the property is not set or the real value type is not compatible with the specified value type, returns defaultValue.

Type Parameters:

T - Type of the property value.

Parameters:

properties - Map of properties to get the property value from.

key - Name of the property.

defaultValue - Default value of the property.

type - Type to retrieve the value as.

legacyMap - Legacy fallback map, where key is the actual property name, value is the old property name

Returns:

Value of the property or null.

getValue

public static <T> T getValue(Map<String,?> properties,
                             RuntimeType runtimeType,
                             String key,
                             T defaultValue,
                             Class<T> type,
                             Map<String,String> legacyMap)

Returns value of a specified property. If the property is not set or the real value type is not compatible with the specified value type, returns defaultValue.

Type Parameters:

T - Type of the property value.

Parameters:

properties - Map of properties to get the property value from.

runtimeType - Runtime type which is used to check whether there is a property with the same key but post-fixed by runtime type (.server or .client) which would override the key property.

key - Name of the property.

defaultValue - Default value of the property.

type - Type to retrieve the value as.

legacyMap - Legacy fallback map, where key is the actual property name, value is the old property name

Returns:

Value of the property or null.

getValue

public static <T> T getValue(Map<String,?> properties,
                             String key,
                             Class<T> type,
                             Map<String,String> legacyMap)

Returns value of a specified property. If the property is not set or the real value type is not compatible with the specified value type, returns null.

Type Parameters:

T - Type of the property value.

Parameters:

properties - Map of properties to get the property value from.

key - Name of the property.

type - Type to retrieve the value as.

legacyMap - Legacy fallback map, where key is the actual property name, value is the old property name

Returns:

Value of the property or null.

getValue

public static <T> T getValue(Map<String,?> properties,
                             RuntimeType runtimeType,
                             String key,
                             Class<T> type,
                             Map<String,String> legacyMap)

Returns value of a specified property. If the property is not set or the real value type is not compatible with the specified value type, returns null.

Type Parameters:

T - Type of the property value.

Parameters:

properties - Map of properties to get the property value from.

runtimeType - Runtime type which is used to check whether there is a property with the same key but post-fixed by runtime type (.server or .client) which would override the key property.

key - Name of the property.

type - Type to retrieve the value as.

Returns:

Value of the property or null.

getPropertyNameForRuntime

public static String getPropertyNameForRuntime(String key,
                                               RuntimeType runtimeType)

Returns specific property value for given RuntimeType. Some properties have complementary client and server versions along with a common version (effective for both environments, if the specific one is not set). This methods returns a specific name for the environment (determined by convention), if runtime is not null, the property is a Jersey property name (starts with jersey.config) and does not contain a runtime specific part already. If those conditions are not met, original property name is returned.

Parameters:

key - property name

runtimeType - runtime type

Returns:

runtime-specific property name, where possible, original key in other cases. original key

convertValue

public static <T> T convertValue(Object value,
                                 Class<T> type)

Convert Object value to a value of the specified class type.

Type Parameters:

T - converted value type.

Parameters:

value - Object value to convert.

type - conversion type.

Returns:

value converted to the specified class type.

isMetaInfServicesEnabled

public static boolean isMetaInfServicesEnabled(Map<String,Object> properties,
                                               RuntimeType runtimeType)

Determine whether CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE does not globally disable META-INF/services lookup on client/server.

Parameters:

properties - map containing application properties. May be null

runtimeType - runtime (client or server) where the service finder binder is used.

Returns:

true if the CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE is not se to true

isJaxRsServiceLoadingEnabled

public static boolean isJaxRsServiceLoadingEnabled(Map<String,Object> properties)

Check whether loading of JAX-RS services is allowed or not. Services shall implement Feature or DynamicFeature interface and be listed as SPI in an application

Parameters:

properties - list of properties to be checked

Returns:

false if loading of JAX-RS services is not enabled

Since:

2.35

isProperty

public static boolean isProperty(Map<String,Object> properties,
                                 String name)

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

Parameters:

properties - key-value map of properties.

name - property name.

Returns:

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

isProperty

public static boolean isProperty(Object value)

Get the value of the property converted to boolean. Returns false if the value is not convertible.

Parameters:

value - property value.

Returns:

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

isPropertyOrNotSet

public static boolean isPropertyOrNotSet(Object value)

Converts the property value to boolean and checks it is true or empty. Returns true if the value is true or empty but not null.

The rationale behind this is that system property -Dprop=true is the same as -Dprop. The property -Dprop=false behaves as if the -Dprop is not set at all.

Parameters:

value - property value.

Returns:

boolean property value or true if the property value is not set or false if the property is otherwise not convertible.