org.nuxeo.runtime.services.config

Interface ConfigurationService

All Known Implementing Classes:

ConfigurationServiceImpl

public interface ConfigurationService

Service holding runtime configuration properties.

Since:

7.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	LIST_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Map<String,Serializable>	getProperties(String namespace) Returns the properties with key starting with the given namespace.
String	getPropertiesAsJson(String namespace) Returns the json string representing the properties with key starting with the given namespace.
String	getProperty(String key) Returns the given property value if any, otherwise null.
String	getProperty(String key, String defaultValue) Returns the given property value if any, otherwise returns the given default value.
boolean	isBooleanPropertyFalse(String key) Returns true if given property is false when compared to a boolean value.
boolean	isBooleanPropertyTrue(String key) Returns true if given property is true when compared to a boolean value.

Field Detail

LIST_SEPARATOR

static final String LIST_SEPARATOR

See Also:

Constant Field Values

Method Detail

getProperty

String getProperty(String key)

Returns the given property value if any, otherwise null.

Parameters:

key - the property key

getProperty

String getProperty(String key,
                   String defaultValue)

Returns the given property value if any, otherwise returns the given default value.

Parameters:

key - the property key

defaultValue - the default value for this key

getProperties

Map<String,Serializable> getProperties(String namespace)

Returns the properties with key starting with the given namespace.

Parameters:

namespace - the namespace

Returns:

a map of properties with trimmed keys (namespace removed)

Since:

10.3

isBooleanPropertyTrue

boolean isBooleanPropertyTrue(String key)

Returns true if given property is true when compared to a boolean value.

isBooleanPropertyFalse

boolean isBooleanPropertyFalse(String key)

Returns true if given property is false when compared to a boolean value.

getPropertiesAsJson

String getPropertiesAsJson(String namespace)
                    throws IOException

Returns the json string representing the properties with key starting with the given namespace.

Parameters:

namespace - the namespace of the properties

Throws:

IOException

Since:

10.3