public interface ConfigurationService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PNAME_CONFIGURATION_FILE_IS_READ_ONLY
The name of the boolean system property which indicates whether the
configuration file is to be considered read-only.
|
static java.lang.String |
PNAME_CONFIGURATION_FILE_NAME
The name of the system property that stores the name of the configuration
file.
|
static java.lang.String |
PNAME_SC_CACHE_DIR_LOCATION
The name of the property that indicates the location of the directory
where Jitsi is to store cached data.
|
static java.lang.String |
PNAME_SC_HOME_DIR_LOCATION
The name of the property that indicates the location of the directory
where Jitsi is to store user specific data such as
configuration files, message and call history.
|
static java.lang.String |
PNAME_SC_HOME_DIR_NAME
The name of the property that indicates the name of the directory where
Jitsi is to store user specific data such as configuration
files, message and call history.
|
static java.lang.String |
PNAME_SC_LOG_DIR_LOCATION
The name of the property that indicates the location of the directory
where Jitsi is to store cached data.
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a
PropertyChangeListener to the listener list. |
void |
addPropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list for a specific
property.
|
void |
addVetoableChangeListener(ConfigVetoableChangeListener listener)
Adds a VetoableChangeListener to the listener list.
|
void |
addVetoableChangeListener(java.lang.String propertyName,
ConfigVetoableChangeListener listener)
Adds a VetoableChangeListener to the listener list for a specific
property.
|
java.util.List<java.lang.String> |
getAllPropertyNames()
Returns a
List of Strings containing all
property names. |
boolean |
getBoolean(java.lang.String propertyName,
boolean defaultValue)
Gets the value of a specific property as a boolean.
|
java.lang.String |
getConfigurationFilename()
Use with caution!
Returns the name of the configuration file currently
used.
|
double |
getDouble(java.lang.String propertyName,
double defaultValue)
Gets the value of a specific property as a double.
|
int |
getInt(java.lang.String propertyName,
int defaultValue)
Gets the value of a specific property as a signed decimal integer.
|
long |
getLong(java.lang.String propertyName,
long defaultValue)
Gets the value of a specific property as a signed decimal long integer.
|
java.lang.Object |
getProperty(java.lang.String propertyName)
Returns the value of the property with the specified name or null if no
such property exists.
|
java.util.List<java.lang.String> |
getPropertyNamesByPrefix(java.lang.String prefix,
boolean exactPrefixMatch)
Returns a
List of Strings containing all property names
that have the specified prefix. |
java.util.List<java.lang.String> |
getPropertyNamesBySuffix(java.lang.String suffix)
Returns a List of Strings containing the property names
that have the specified suffix.
|
java.lang.String |
getScHomeDirLocation()
Returns the location of the directory where Jitsi is to store
user specific data such as configuration files, message and call history
as well as is bundle repository.
|
java.lang.String |
getScHomeDirName()
Returns the name of the directory where Jitsi is to store user
specific data such as configuration files, message and call history
as well as is bundle repository.
|
java.lang.String |
getString(java.lang.String propertyName)
Returns the String value of the specified property and null in case no
property value was mapped against the specified propertyName, or in
case the returned property string had zero length or contained
whitespaces only.
|
java.lang.String |
getString(java.lang.String propertyName,
java.lang.String defaultValue)
Returns the String value of the specified property and null in case no
property value was mapped against the specified propertyName, or in
case the returned property string had zero length or contained
whitespaces only.
|
void |
logConfigurationProperties(java.lang.String passwordPattern)
Prints all configuration properties on 'INFO' logging level *except*
that properties which name matches given regular expression will have
their values masked with ***.
|
void |
purgeStoredConfiguration()
Removes all locally stored properties leaving an empty configuration.
|
void |
reloadConfiguration()
Deletes the current configuration and reloads it from the configuration
file.
|
void |
removeProperty(java.lang.String propertyName)
Removes the property with the specified name.
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a
PropertyChangeListener from the listener list. |
void |
removePropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list for a specific
property.
|
void |
removeVetoableChangeListener(ConfigVetoableChangeListener listener)
Removes a VetoableChangeListener from the listener list.
|
void |
removeVetoableChangeListener(java.lang.String propertyName,
ConfigVetoableChangeListener listener)
Removes a VetoableChangeListener from the listener list for a specific
property.
|
void |
setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
Sets a set of specific properties to specific values as a batch operation
meaning that first
VetoableChangeListener s are asked to
approve the modifications of the specified properties to the specified
values, then the modifications are performed if no complaints have been
raised in the form of PropertyVetoException and finally
PropertyChangeListener s are notified about the changes of
each of the specified properties. |
void |
setProperty(java.lang.String propertyName,
java.lang.Object property)
Sets the property with the specified name to the specified value.
|
void |
setProperty(java.lang.String propertyName,
java.lang.Object property,
boolean isSystem)
Sets the property with the specified name to the specified value.
|
void |
storeConfiguration()
Store the current set of properties back to the configuration file.
|
static final java.lang.String PNAME_SC_HOME_DIR_NAME
static final java.lang.String PNAME_SC_HOME_DIR_LOCATION
static final java.lang.String PNAME_SC_CACHE_DIR_LOCATION
static final java.lang.String PNAME_SC_LOG_DIR_LOCATION
static final java.lang.String PNAME_CONFIGURATION_FILE_IS_READ_ONLY
static final java.lang.String PNAME_CONFIGURATION_FILE_NAME
void setProperty(java.lang.String propertyName, java.lang.Object property)
propertyName
- the name of the property to change.property
- the new value of the specified property.ConfigPropertyVetoException
- in case the changed has been refused
by at least one propertychange listener.void setProperty(java.lang.String propertyName, java.lang.Object property, boolean isSystem)
propertyName
- the name of the property to change.property
- the new value of the specified property.isSystem
- specifies whether or not the property being set is a
System property and should be resolved against the system property set.ConfigPropertyVetoException
- in case the changed has been refused by
at least one propertychange listener.void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
VetoableChangeListener
s are asked to
approve the modifications of the specified properties to the specified
values, then the modifications are performed if no complaints have been
raised in the form of PropertyVetoException
and finally
PropertyChangeListener
s are notified about the changes of
each of the specified properties. The batch operations allows the
ConfigurationService
implementations to optimize, for
example, the saving of the configuration which in this case can be
performed only once for the setting of multiple properties.properties
- a Map
of property names to their new values to
be set.ConfigPropertyVetoException
- if a change in at least one of the
properties has been refused by at least one of the VetoableChangeListener
s.java.lang.Object getProperty(java.lang.String propertyName)
propertyName
- the name of the property that is being queried.void removeProperty(java.lang.String propertyName)
propertyName
- the name of the property to change.ConfigPropertyVetoException
- in case the changed has been refused by
at least one propertychange listener.java.util.List<java.lang.String> getAllPropertyNames()
List
of Strings containing all
property names.List
containing all property names.java.util.List<java.lang.String> getPropertyNamesByPrefix(java.lang.String prefix, boolean exactPrefixMatch)
List
of Strings containing all property names
that have the specified prefix. The return value will include property
names that have prefixes longer than specified, unless the
exactPrefixMatch parameter is true.
Example:
Imagine a configuration service instance containing 2 properties only:
net.java.sip.communicator.PROP1=value1
net.java.sip.communicator.service.protocol.PROP1=value2
A call to this method with a prefix="net.java.sip.communicator" and exactPrefixMatch=true would only return the first property - net.java.sip.communicator.PROP1, whereas the same call with exactPrefixMatch=false would return both properties as the second prefix includes the requested prefix string.
prefix
- a String containing the prefix (the non dotted non-caps
part of a property name) that we're looking for.exactPrefixMatch
- a boolean indicating whether the returned
property names should all have a prefix that is an exact match of the
the prefix param or whether properties with prefixes that
contain it but are longer than it are also accepted.java.util.List<java.lang.String> getPropertyNamesBySuffix(java.lang.String suffix)
For example, imagine a configuration service instance containing two properties only:
net.java.sip.communicator.PROP1=value1
net.java.sip.communicator.service.protocol.PROP1=value2
A call to this method with suffix equal to "PROP1" will return both properties, whereas the call with suffix equal to "communicator.PROP1" or "PROP2" will return an empty List. Thus, if the suffix argument contains a dot, nothing will be found.
suffix
- the suffix for the property names to be returnedjava.lang.String getString(java.lang.String propertyName)
propertyName
- the name of the property that is being queried.java.lang.String getString(java.lang.String propertyName, java.lang.String defaultValue)
propertyName
- the name of the property that is being queried.defaultValue
- the value to be returned if the specified property
name is not associated with a value in this
ConfigurationService
defaultValue
in case there was no value mapped against
the specified propertyName, or the returned string had zero
length or contained whitespaces only.boolean getBoolean(java.lang.String propertyName, boolean defaultValue)
ConfigurationService
, the string representation of the value
is parsed into a boolean according to the rules of
Boolean.parseBoolean(String)
. Otherwise,
defaultValue
is returned.propertyName
- the name of the property to get the value of as a booleandefaultValue
- the value to be returned if the specified property name is not
associated with a value in this
ConfigurationService
ConfigurationService
as a boolean;
defaultValue
if the property with the specified name
is not associated with a value in this
ConfigurationService
int getInt(java.lang.String propertyName, int defaultValue)
Integer.parseInt(String)
. If parsing the value as a signed
decimal integer fails or there is no value associated with the specified
property name, defaultValue is returned.propertyName
- the name of the property to get the value of as a
signed decimal integerdefaultValue
- the value to be returned if parsing the value of the
specified property name as a signed decimal integer fails or there is no
value associated with the specified property name in this
ConfigurationServicedouble getDouble(java.lang.String propertyName, double defaultValue)
Double.parseDouble(String)
. If there is no value, or parsing of the
value fails, defaultValue is returned.propertyName
- the name of the property.defaultValue
- the default value to be returned.long getLong(java.lang.String propertyName, long defaultValue)
Long.parseLong(String)
. If parsing the value as a signed
decimal long integer fails or there is no value associated with the
specified property name, defaultValue is returned.propertyName
- the name of the property to get the value of as a
signed decimal long integerdefaultValue
- the value to be returned if parsing the value of the
specified property name as a signed decimal long integer fails or there
is no value associated with the specified property name in this
ConfigurationServicevoid addPropertyChangeListener(java.beans.PropertyChangeListener listener)
PropertyChangeListener
to the listener list. The listener
is registered for all properties in the current configuration.
listener
- the PropertyChangeListener
to be addedvoid removePropertyChangeListener(java.beans.PropertyChangeListener listener)
PropertyChangeListener
from the listener list.
listener
- the PropertyChangeListener
to be removedvoid addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
propertyName
- one of the property names listed abovelistener
- the PropertyChangeListener to be addedvoid removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
propertyName
- a valid property namelistener
- the PropertyChangeListener to be removedvoid addVetoableChangeListener(ConfigVetoableChangeListener listener)
listener
- the VetoableChangeListener to be addedvoid removeVetoableChangeListener(ConfigVetoableChangeListener listener)
listener
- the VetoableChangeListener to be removedvoid addVetoableChangeListener(java.lang.String propertyName, ConfigVetoableChangeListener listener)
propertyName
- one of the property names listed abovelistener
- the VetoableChangeListener to be addedvoid removeVetoableChangeListener(java.lang.String propertyName, ConfigVetoableChangeListener listener)
propertyName
- a valid property namelistener
- the VetoableChangeListener to be removedvoid storeConfiguration() throws java.io.IOException
In the last case the file is copied to the sip-communicator configuration directory right after being extracted from the classpath location.
java.io.IOException
- in case storing the configuration failed.void reloadConfiguration() throws java.io.IOException
In the last case the file is copied to the sip-communicator configuration directory right after being extracted from the classpath location.
java.io.IOException
- in case reading the configuration fails.void purgeStoredConfiguration()
void logConfigurationProperties(java.lang.String passwordPattern)
passwordPattern
- regular expression which detects properties which
values should be masked.java.lang.String getScHomeDirName()
java.lang.String getScHomeDirLocation()
java.lang.String getConfigurationFilename()
getScHomeDirLocation()
getScHomeDirName()
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.