Package org.jivesoftware.util
Class JiveProperties
- java.lang.Object
-
- org.jivesoftware.util.JiveProperties
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
boolean
containsKey(Object key)
boolean
containsValue(Object value)
static void
disableDatabasePersistence()
Prevent JiveProperties from interacting with the database.Set<Map.Entry<String,String>>
entrySet()
String
get(Object key)
boolean
getBooleanProperty(String name)
boolean
getBooleanProperty(String name, boolean defaultValue)
Collection<String>
getChildrenNames(String parentKey)
Return all children property names of a parent property as a Collection of String objects.static JiveProperties
getInstance()
Returns a singleton instance of JiveProperties.String
getProperty(String name, String defaultValue)
Collection<String>
getPropertyNames()
Returns all property names as a Collection of String values.void
init()
For internal use only.boolean
isEmpty()
Set<String>
keySet()
String
put(String key, String value)
String
put(String key, String value, boolean isEncrypted)
Saves a property, optionally encrypting itvoid
putAll(Map<? extends String,? extends String> t)
String
remove(Object key)
int
size()
Collection<String>
values()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Method Detail
-
disableDatabasePersistence
public static void disableDatabasePersistence()
Prevent JiveProperties from interacting with the database. On rare occasions - that typically involve running tests - Openfire code will be invoked without a database being available. In such cases, it's undesirable for properties to be retrieved and stored to the database, as this will require a significant amount of resource usage, but will silently fail. This method can only be invoked beforegetInstance()
is being invoked. This intends to prevent a behavioral change at some time after the server was started.
-
getInstance
public static JiveProperties getInstance()
Returns a singleton instance of JiveProperties.- Returns:
- an instance of JiveProperties.
-
init
public void init()
For internal use only. This method allows for the reloading of all properties from the values in the database. This is required since it's quite possible during the setup process that a database connection will not be available till after this class is initialized. Thus, if there are existing properties in the database we will want to reload this class after the setup process has been completed.
-
containsKey
public boolean containsKey(Object key)
- Specified by:
containsKey
in interfaceMap<String,String>
-
containsValue
public boolean containsValue(Object value)
- Specified by:
containsValue
in interfaceMap<String,String>
-
getChildrenNames
public Collection<String> getChildrenNames(String parentKey)
Return all children property names of a parent property as a Collection of String objects. For example, given the propertiesX.Y.A
,X.Y.B
, andX.Y.C
, then the child properties ofX.Y
areX.Y.A
,X.Y.B
, andX.Y.C
. The method is not recursive; ie, it does not return children of children.- Parameters:
parentKey
- the name of the parent property.- Returns:
- all child property names for the given parent.
-
getPropertyNames
public Collection<String> getPropertyNames()
Returns all property names as a Collection of String values.- Returns:
- all property names.
-
put
public String put(String key, String value, boolean isEncrypted)
Saves a property, optionally encrypting it- Parameters:
key
- The name of the propertyvalue
- The value of the propertyisEncrypted
-true
to encrypt the property,true
to leave in plain text- Returns:
- The previous value associated with
key
, ornull
if there was no mapping forkey
.
-
getBooleanProperty
public boolean getBooleanProperty(String name)
-
getBooleanProperty
public boolean getBooleanProperty(String name, boolean defaultValue)
-
-