org.opencastproject.util

Class XProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.opencastproject.util.XProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class XProperties
extends Properties

An extension to the Properties class which performs the following when you call getProperty: 1. Checks to see if there are any variables in the property 2. If so it replaces the variable with with the first match it finds in the following order - The java properties (java -Dkey=value) - The component context properties (set using setBundleContext) - The properties set in the object itself - The container's environment variables This class operates identically to a standard Properties object in all other respects.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	END_REPLACEMENT
static String	START_REPLACEMENT

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
XProperties()

Method Summary

Modifier and Type	Method and Description
String	expandVariable(String variable) Returns the value of a variable with the same priority replacement scheme as getProperty.
org.osgi.framework.BundleContext	getBundleContext() Return the current BundleContext that's in use by this object.
String	getProperty(String key) See the class description for more details.
String	getUninterpretedProperty(String key) A wrapper around the old getProperty behaviour, this method does not do any variable expansion.
void	merge(Dictionary<String,String> p) Merges the properties from p into this properties object
String	replacePropertiesInCustomString(String customString) This goes through the customString provided by the client and checks for any properties that they may wish substituted by ConfigurationManager properties such as ${capture.filesystem.cache.capture.url} would be replaced by the actual location of the capture cache.
void	setBundleContext(org.osgi.framework.BundleContext ctx) Sets the BundleContext for this object.

Methods inherited from class java.util.Properties

getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

START_REPLACEMENT

public static final String START_REPLACEMENT

See Also:

Constant Field Values

END_REPLACEMENT

public static final String END_REPLACEMENT

See Also:

Constant Field Values

Constructor Detail

XProperties

public XProperties()

Method Detail

getProperty

public String getProperty(String key)

See the class description for more details.

Overrides:

getProperty in class Properties

See Also:

Properties.getProperty(java.lang.String)

replacePropertiesInCustomString

public String replacePropertiesInCustomString(String customString)

This goes through the customString provided by the client and checks for any properties that they may wish substituted by ConfigurationManager properties such as ${capture.filesystem.cache.capture.url} would be replaced by the actual location of the capture cache.

Parameters:

customString - The String that you want to substitute the properties into

Returns:

The customString with all of the ${property} it was able to substitute.

expandVariable

public String expandVariable(String variable)

Returns the value of a variable with the same priority replacement scheme as getProperty.

Parameters:

variable - The variable you need the replacement for.

Returns:

The value for variable.

See Also:

getProperty(String)

getUninterpretedProperty

public String getUninterpretedProperty(String key)

A wrapper around the old getProperty behaviour, this method does not do any variable expansion.

Parameters:

key - The key of the property

Returns:

The property exactly as it appears in the properties list without any variable expansion

merge

public void merge(Dictionary<String,String> p)

Merges the properties from p into this properties object

Parameters:

p - The Dictionary you wish to add to this object

setBundleContext

public void setBundleContext(org.osgi.framework.BundleContext ctx)

Sets the BundleContext for this object. Set this to null if you wish to skip checking the context for a property.

Parameters:

ctx - The BundleContext for this instance.

getBundleContext

public org.osgi.framework.BundleContext getBundleContext()

Return the current BundleContext that's in use by this object.

Returns:

The current BundleContext