Class JProperties
- All Implemented Interfaces:
Serializable,Cloneable,Map<String,String>
- Direct Known Subclasses:
LangProperties
Properties manage properties file in UTF-8 encoding.
Its save updateAndSave(File) methods keep layout of previous properties file.
Thread-safety: all read methods (getProperty, getXxxProperty, getProperties, getSubProperties...) are lock-free. Write methods are synchronized on this instance.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringSuffix identifying a property whose value is encrypted, for exampledb.password.crypt.protected Set<JPropertiesListener> protected static final intprotected Map<String, JProperties> protected boolean -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJProperties(JProperties jProperties) Constructor with a parent JProperties (used only for resolve linked properties when subProperties feature is used. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddProperties(JProperties prop) Add every property of the givenJPropertiesto thisJProperties.voidaddProperties(Properties prop) Add every property of the givenPropertiesto thisJProperties.voidAdds a listener for any change of this JProperties.voidaddProtectedKeys(Collection<String> col) Registers additional protected property names, for keys that do not follow theENCRYPTED_EXTENSIONconvention.protected static String[]buildArrayFromString(String value, String[] defaultValue) Convert a string to a String[] using the following formats: "@{delim}value1{delim}value2...", where{delim}is one character delimiter of your choice. "value1{delim}value2{delim}...", where{delim}is a character from\t\n\r\f.protected JPropertiescheckCacheGetProperties(String prefix) voidclear()voidClear all properties.clone()computeIfAbsent(String key, Function<? super String, ? extends String> function) computeIfPresent(String key, BiFunction<? super String, ? super String, ? extends String> function) booleanbooleancontainsKey(Object key) booleancontainsProperty(String name) Tests if this JProperties contains the given property key/name.booleancontainsValue(Object val) elements()entrySet()booleanvoidTriggers a properties change to notify all listener of this JProperties.voidforEach(BiConsumer<? super String, ? super String> action) booleangetBooleanProperty(String name, boolean defaultValue) Gets the value of a property as a boolean given its key/name.doublegetDoubleProperty(String name, double defaultValue) Gets the value of a property as a double value given its key/name.floatgetFloatProperty(String name, float defaultValue) Gets the value of a property as a float value given its key/name.int[]getIntArrayProperty(String name, int[] defaultValue) Gets the value of a property as a int array.intgetIntegerProperty(String name, int defaultValue) Gets the value of a property as an int value given its key/name.Retrieve set of allJPropertiesListeneruse by this JProperties instance.Retrieve a set of all that were loaded in this JProperties instance (ordered by the load order)longgetLongProperty(String name, long defaultValue) Gets the value of a property as a long value given its key/name.getOrDefault(Object key, String def) getProperties(String prefix) Returns a new property set of properties with key matching a given prefix.getProperty(String name) Gets value of a property.getProperty(String name, String defaultValue) Gets the value of a property given its key/name.Returns the names of the protected properties, that is properties holding sensitive data whose value must be concealed when displayed or saved (see JProperties.isSensitiveProperty(String)).String[]getStringArrayProperty(String name, String[] defaultValue) Gets the value of a property as a String array.getSubProperties(String prefix) Returns a map of properties built from those properties and having a given prefix.
Example:
prop:
foo.bar.case1.x: value of x for case1
foo.bar.case1.y: value of y for case1
foo.bar.case2.x: value of x for case2
foo.bar.case2.y: value of y for case2
foo.bar.case2.z.t: value of z for case2inthashCode()voidInvalidate the cache used forgetProperties(String)method (and thereforegetSubProperties(String)).booleanisEmpty()booleanCheck if the specified property key is considered to be sensitive and for which values is being concealed or crypted on saved.keys()keySet()voidReads a property file (key and element pairs) from the given File.voidReads a property file (key and element pairs) from the given File.voidReads a property file (key and element pairs) from the given File.voidReads a property file (key and element pairs) from the given File.merge(String key, String value, BiFunction<? super String, ? super String, ? extends String> function) static JPropertiesvoidprotected voidputCacheGetProperties(String prefix, JProperties prop) putIfAbsent(String key, String value) booleanvoidRemoves a listener for any change of this JProperties.booleanvoidreplaceAll(BiFunction<? super String, ? super String, ? extends String> function) voidsetListenerSet(Set<JPropertiesListener> listeners) Set the Set ofJPropertiesListenerthat this JProperties instance must used to notifysetProperty(String name, String value) Sets value of a property.intsize()toString()voidupdateAndSave(File file) Updates and save properties.values()
-
Field Details
-
PREFIX_PROPERTIES_CACHE_MAX_ENTRIES
protected static final int PREFIX_PROPERTIES_CACHE_MAX_ENTRIES- See Also:
-
prefixPropertiesCache
-
propertyNameAsDefaultValue
protected boolean propertyNameAsDefaultValue -
listenerSet
-
SENSITIVE_KEYWORD
-
ENCRYPTED_EXTENSION
Suffix identifying a property whose value is encrypted, for exampledb.password.crypt. When such a key is written, its name without the suffix (db.password) is registered as a protected key. Subclasses may change it.- See Also:
-
-
Constructor Details
-
JProperties
public JProperties() -
JProperties
Constructor with a parent JProperties (used only for resolve linked properties when subProperties feature is used.- Parameters:
jProperties- parentJPropertiesobject, used for linked property resolution
-
-
Method Details
-
getListenerSet
Retrieve set of allJPropertiesListeneruse by this JProperties instance.- Returns:
- the set of all listeners for this JProperties.
- Since:
- public since jcms-10.0.3 - JCMS-6890
- See Also:
-
setListenerSet
Set the Set ofJPropertiesListenerthat this JProperties instance must used to notify- Parameters:
listeners- a Set of JProperties listener to assigne (listener are cleared if null is specified)- Since:
- jcms-10.0.3 - JCMS-6890
- See Also:
-
addPropertiesListener
Adds a listener for any change of this JProperties.- Parameters:
l- the listener to add- See Also:
-
removePropertiesListener
Removes a listener for any change of this JProperties.- Parameters:
l- the listener to remove- See Also:
-
firePropertiesChange
public void firePropertiesChange()Triggers a properties change to notify all listener of this JProperties.- See Also:
-
containsProperty
Tests if this JProperties contains the given property key/name.- Parameters:
name- the key/name of the property to check- Returns:
- true if the specified object is a key in this hashtable; false otherwise.
-
getProperty
Gets value of a property.- Parameters:
name- the key/name of the property to retrieve- Returns:
- the property value
-
getProperty
Gets the value of a property given its key/name.- Parameters:
name- the key/name of the property to retrievedefaultValue- the default value to use if the existing value is null.- Returns:
- the value of a property given its key/name.
-
setProperty
Sets value of a property.- Parameters:
name- the key/name of the property to retrievevalue- the new value to assign.- Returns:
- the previous value of the specified key/name
-
getBooleanProperty
Gets the value of a property as a boolean given its key/name.- Parameters:
name- the key/name of the property to retrievedefaultValue- the default value to use if the existing value is null or is neither "false" nor "true" (case sensitive).- Returns:
- the boolean value of the property
-
getIntegerProperty
Gets the value of a property as an int value given its key/name.- Parameters:
name- the key/name of the property to retrievedefaultValue- the default value to use if the existing value is null or if Integer.parseInt() throws exception during String to int conversion.- Returns:
- the int value of the property
-
getLongProperty
Gets the value of a property as a long value given its key/name.- Parameters:
name- the key/name of the property to retrievedefaultValue- the default value to use if the existing value is null or if Long.parseLong() throws exception during String to long conversion.- Returns:
- the long value of the property
-
getFloatProperty
Gets the value of a property as a float value given its key/name.- Parameters:
name- the key/name of the property to retrievedefaultValue- the default value to use if the existing value is null or if Float.parseFloat() throws exception during String to float conversion.- Returns:
- the float value of the property
-
getDoubleProperty
Gets the value of a property as a double value given its key/name.- Parameters:
name- the key/name of the property to retrievedefaultValue- the default value to use if the existing value is null or if Double.parseDouble() throws exception during String to double conversion.- Returns:
- the double value of the property
-
getStringArrayProperty
Gets the value of a property as a String array.The property value must be in one of the following forms:
- "@{delim}value1{delim}value2...", where
{delim}is one character delimiter of your choice. - "value1{delim}value2{delim}...", where
{delim}is a character from\t\n\r\f.
String[] array = prop.getStringArrayProperty("missingexample", new String[] { "default", "value"}); assertEquals(2, array.length); assertEquals("default", array[0]); assertEquals("value", array[1]); prop.setProperty("example1", "@|abc|def"); String[] array1 = prop.getStringArrayProperty("example1", new String[] { }); assertEquals(2, array1.length); assertEquals("abc", array1[0]); assertEquals("def", array1[1]); prop.setProperty("example2", "foo bar\tzig"); String[] array2 = prop.getStringArrayProperty("example2", new String[] { }); assertEquals(3, array2.length); assertEquals("foo", array2[0]); assertEquals("bar", array2[1]); assertEquals("zig", array2[2]);- Parameters:
name- the key/name of the property to retrievedefaultValue- the default value to use if the existing value is null or no values could be found in the conversion.- Returns:
- a String array
- "@{delim}value1{delim}value2...", where
-
buildArrayFromString
Convert a string to a String[] using the following formats:- "@{delim}value1{delim}value2...", where
{delim}is one character delimiter of your choice. - "value1{delim}value2{delim}...", where
{delim}is a character from\t\n\r\f.
- Parameters:
value- the valuedefaultValue- the default value- Returns:
- an array of String
- "@{delim}value1{delim}value2...", where
-
getIntArrayProperty
Gets the value of a property as a int array. Uses same format ofgetStringArrayProperty(String, String[]).- Parameters:
name- the key/name of the property to retrievedefaultValue- the default value to use if the existing value is null or no values could be found in the conversion.- Returns:
- an int array
- See Also:
-
addProperties
Add every property of the givenPropertiesto thisJProperties.- Parameters:
prop- the properties to be added
-
addProperties
Add every property of the givenJPropertiesto thisJProperties.- Parameters:
prop- the jproperties to be added
-
checkCacheGetProperties
-
putCacheGetProperties
-
invalidateCacheGetProperties
public void invalidateCacheGetProperties()Invalidate the cache used forgetProperties(String)method (and thereforegetSubProperties(String)).The cache map is replaced by a new empty one rather than cleared: a getProperties(String) call started before the invalidation stores its result, possibly built from the old content, in the discarded map, so it is never served afterwards. The call is cheap (an empty ConcurrentHashMap allocates its table lazily), lock-free and can be made from any thread.
- Since:
- jcms-8.0.2
-
getProperties
Returns a new property set of properties with key matching a given prefix.- Parameters:
prefix- the prefix the properties must match to be added to the returned JProperties instance, if null, all properties are added.- Returns:
- a new property set of properties with key matching a given prefix.
-
getSubProperties
Returns a map of properties built from those properties and having a given prefix.
Example:
prop:
foo.bar.case1.x: value of x for case1
foo.bar.case1.y: value of y for case1
foo.bar.case2.x: value of x for case2
foo.bar.case2.y: value of y for case2
foo.bar.case2.z.t: value of z for case2
prop.getSubProperties("foo.bar.")returns a Map with the keyscase1andcase2.
A JProperties is bound to
case1and it contains the properties:
x: value of x for case1
y: value of y for case1
A JProperties is bound to
case2and it contains the properties:
x: value of x for case2
y: value of y for case2
z.t: value of z for case2- Parameters:
prefix- the prefix- Returns:
- a map with string as the key and either String or JProperties as the value.
- Since:
- jcms-5.7.2
-
clearProperties
public void clearProperties()Clear all properties. -
load
Reads a property file (key and element pairs) from the given File. The file encoding is assumed to be UTF-8.- Parameters:
file- the file from which to read properties.- Throws:
IOException- if an error occurred when reading from the input stream.IllegalArgumentException- if the input stream contains a malformed Unicode escape sequence.- See Also:
-
load
Reads a property file (key and element pairs) from the given File. The file encoding is assumed to be UTF-8.- Parameters:
file- the file from which to read properties.unprotectSensitiveData- true if sensitive data should be unprotected after read- Throws:
IOException- if an error occurred when reading from the input stream.IllegalArgumentException- if the input stream contains a malformed Unicode escape sequence.- See Also:
-
load
Reads a property file (key and element pairs) from the given File. The file encoding is assumed to be UTF-8.- Parameters:
file- the file from which to read properties.prefix- a prefix to use add to all properties' name. if null, no prefix is used.- Throws:
IOException- if an error occurred when reading from the input stream.IllegalArgumentException- if the input stream contains a malformed Unicode escape sequence.- See Also:
-
load
Reads a property file (key and element pairs) from the given File. The file encoding is assumed to be UTF-8.- Parameters:
file- the file from which to read properties.prefix- a prefix to use add to all properties' name. if null, no prefix is used.unprotectSensitiveData- true if sensitive data should be unprotected after read- Throws:
IOException- if an error occurred when reading from the input stream.IllegalArgumentException- if the input stream contains a malformed Unicode escape sequence.- See Also:
-
getLoadedFiles
Retrieve a set of all that were loaded in this JProperties instance (ordered by the load order)- Returns:
- a Set, never returns null
- Since:
- JCMS-6735
-
updateAndSave
Updates and save properties. The original layout is preserved for existing properties and comments New properties are appended.- Parameters:
file- the properties File to read and update.- Throws:
IOException- IOException thrown in method
-
isSensitiveProperty
Check if the specified property key is considered to be sensitive and for which values is being concealed or crypted on saved.- Parameters:
key- the name of the property being verified- Returns:
- true if property is sensitive, false otherwise
- Since:
- jcms-10.0.3 / JCMS-7225 (initally introduce as private in jcms-10.0.2 / JCMS-6928)
-
toString
-
parse
-
getProtectedKeySet
Returns the names of the protected properties, that is properties holding sensitive data whose value must be concealed when displayed or saved (see JProperties.isSensitiveProperty(String)).The set is filled automatically: each time a key ending with
ENCRYPTED_EXTENSIONis written (put, putAll, putIfAbsent, compute, computeIfAbsent, merge), the key without its last dot-separated part is added (db.password.cryptregistersdb.password). Keys can also be added explicitly withaddProtectedKeys(Collection). Removing a property does not remove its protected key.The returned set is live and modifiable: changes made to it apply to this instance. It is thread-safe and can be iterated while other threads write, without ConcurrentModificationException. A clone() shares this set with the original (shallow copy).
- Returns:
- the set of protected property names, never null
- See Also:
-
addProtectedKeys
Registers additional protected property names, for keys that do not follow theENCRYPTED_EXTENSIONconvention. The names are added as is (no suffix is removed) to the set returned bygetProtectedKeySet().- Parameters:
col- the property names to protect; ignored if null- See Also:
-
size
public int size() -
isEmpty
public boolean isEmpty() -
get
-
getOrDefault
- Specified by:
getOrDefaultin interfaceMap<K,V> - Overrides:
getOrDefaultin classHashtable<K,V>
-
containsKey
- Specified by:
containsKeyin interfaceMap<K,V> - Overrides:
containsKeyin classHashtable<K,V>
-
containsValue
- Specified by:
containsValuein interfaceMap<K,V> - Overrides:
containsValuein classHashtable<K,V>
-
contains
-
keys
-
elements
-
forEach
-
keySet
-
values
-
entrySet
-
put
-
remove
-
clear
public void clear() -
putAll
-
putIfAbsent
- Specified by:
putIfAbsentin interfaceMap<K,V> - Overrides:
putIfAbsentin classHashtable<K,V>
-
remove
-
replace
-
replace
-
replaceAll
- Specified by:
replaceAllin interfaceMap<K,V> - Overrides:
replaceAllin classHashtable<K,V>
-
computeIfAbsent
- Specified by:
computeIfAbsentin interfaceMap<K,V> - Overrides:
computeIfAbsentin classHashtable<K,V>
-
computeIfPresent
public String computeIfPresent(String key, BiFunction<? super String, ? super String, ? extends String> function) - Specified by:
computeIfPresentin interfaceMap<K,V> - Overrides:
computeIfPresentin classHashtable<K,V>
-
compute
-
merge
-
equals
-
hashCode
public int hashCode() -
clone
-