Class FWPropertyProvider
java.lang.Object
net.simplace.core.property.FWPropertyProvider
Provider for properties. It centralizes access
to properties throughout the whole application. In
addition to making direct access to property files
obsolete it also caches whole sets of properties (i.e.
property files) by keeping them in memory. A property
set is loaded into memory when any of the properties
contained in it is being accessed for the first time.
A property set name is read from name_config.xml, first from the user cache directory
~/tmp/properties, then from the classpath. It also gives access to environment, registry and Java
runtime variables.
- Author:
- Andreas Enders
-
Method Summary
Modifier and TypeMethodDescriptionReturns the environment-variables.static FWPropertyProviderGet Singleton instance of PropertyResourceManager.static StringgetJavaRuntimeVariable(String aKey) Returns a Java system property with forward slashes; forjava.io.tmpdirtrailing separators are removed.getPropertiesAsString(String aPropertyset) Returns a property set as XML text.getProperty(String aPropertySet, String aKey) Get the value of a property in a specific set.getProperty(String aPropertySet, String aKey, String aDefault) Get the value of a property in a specific set.getPropertyContainer(String aPropertySet) Return the complete Properties object.getPropertyNames(String aPropertySet) Return the property names contained in the specified property set.getPropertySetURL(String aPropertySet) Get the URL the specified property set has been loaded from.Returns an environment variable, or else the Java system property with this name.Return the complete Properties object.static StringGets the value for a given registry key.replaceSystemVariables(String aPropertyValue) Replaces one system variable in a property value:%{registry key}(registry),%NAME%(environment),${name}(Java runtime) or$NAME$(environment).voidsavePropertyContainer(FWPropertyContainer aPropertiesContainer) Saves a property set asname_config.xmlin the cache directory (whichlocatePropertySet(String)prefers when loading) and keeps it in memory.booleansetProperty(String aPropertySet, String aKey, String aValue) Set the value for a specified key within a specified property set and make those settings persistent, so the next time the application is started the set value is still available.booleansetProperty(String aPropertySet, String aKey, String aValue, boolean aNewValue) Set the value for a specified key within a specified property set and make those settings persistent, so the next time the application is started the set value is still available.static booleansetSystemEnvironmentVariable(String aKey, String aValue) Deprecated.has no effect
-
Method Details
-
getInstance
Get Singleton instance of PropertyResourceManager.- Returns:
- the Instance of PropertyProvider (singleton)
-
getProperty
Get the value of a property in a specific set. If the set doesnt contain a value for the given property return the specified default value.- Parameters:
aPropertySet- name of the property setaKey- the property keyaDefault- value returned if the property is missing- Returns:
- the property value with system variables replaced (see
replaceSystemVariables(String)), or the default
-
getProperty
Get the value of a property in a specific set. If the set doesn't contain a value for the given property or if the set doesn't exist anyway return. - Parameters:
aPropertySet- name of the property setaKey- the property key- Returns:
- the property value with system variables replaced, or
null(a warning is logged)
-
getSystemEnvironmentVariable
-
getSystemRegistryVariable
Gets the value for a given registry key. A registry key is composed of a registry root key and path. If the registry key is not present or can not be found (non-Windows systems)nullis returned. Windows registry values are stored by root key and path. The parameterregistryKeycontains the following format:ROOT_KEY\PATH\VALUEfor a specific value orROOT_KEY\PATH\to return the default value. ExampleregistryKeyvalues:HKEY_CURRENT_USER\Environment\JAVA_HOMEHKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Internet Explorer\Search\SearchAssistantHKEY_CLASSES_ROOT\Shell\shell\open\command\Supported root key values are:HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_DYN_DATA HKEY_LOCAL_MACHINE HKEY_PERFORMANCE_DATA HKEY_USERSCallinggetSystemRegistryVariable("HKEY_CLASSES_ROOT\Shell\shell\open\command\")would return%SystemRoot%\Explorer.exe /idlist,%I,%Lon a typical Windows installation.- Parameters:
aKey- the registry keyROOT_KEY\PATH\VALUE- Returns:
- the system registry variable value, or
null
-
getJavaRuntimeVariable
-
setSystemEnvironmentVariable
Deprecated.has no effectNot supported: a Java process cannot change its own environment variables (runningsetin a shell only affected that child process). A warning is logged.- Parameters:
aKey- the variable nameaValue- the value- Returns:
- always
false
-
setProperty
Set the value for a specified key within a specified property set and make those settings persistent, so the next time the application is started the set value is still available. This is essential for adding user settings capabilities to applications. The key given as a parameter to this method must exist in the (original) property set. No new keys can be added. If the key does not exist the method will returnfalselike in any other case of an error.- Parameters:
aPropertySet- name of the property setaKey- the property key (must exist)aValue- the new value;nullremoves the property- Returns:
trueif successful
-
setProperty
Set the value for a specified key within a specified property set and make those settings persistent, so the next time the application is started the set value is still available. Line breaks are stored as\n. UnlessaNewValueis set, the key must exist in the property set. If the key does not exist the method will returnfalselike in any other case of an error.- Parameters:
aPropertySet- name of the property setaKey- the property keyaValue- the new value;nullremoves the propertyaNewValue-trueto allow adding a new key- Returns:
trueif successful
-
getPropertyContainer
Return the complete Properties object. Can cause data corruption in property resource manager, so better use getPropertyNames(...) to get an enumeration of property names and then iterate over this enumeration and invoke getProperty(...) for each name.- Parameters:
aPropertySet- name of the property set- Returns:
- the property container for this property set (loaded on first access), or
nullif it cannot be found or read
-
getSystemPropertyContainer
Return the complete Properties object. Can cause data corruption in property resource manager, so better use getPropertyNames(...) to get an enumeration of property names and then iterate over this enumeration and invoke getProperty(...) for each name.- Returns:
- the property container of the application (named after the locale prefix of the layout, or
LAPClientwithout GUI)
-
getPropertyNames
-
getPropertySetURL
-
getEnvVars
Returns the environment-variables.- Returns:
- the property container of the EnvVars
-
replaceSystemVariables
Replaces one system variable in a property value:%{registry key}(registry),%NAME%(environment),${name}(Java runtime) or$NAME$(environment). Only the first kind found is replaced.- Parameters:
aPropertyValue- the property value- Returns:
- the value with the variable replaced, or the unchanged value on errors (logged)
-
getPropertiesAsString
-
savePropertyContainer
Saves a property set asname_config.xmlin the cache directory (whichlocatePropertySet(String)prefers when loading) and keeps it in memory. The original file in the class path (application directory or jar) is never overwritten. Errors are logged.- Parameters:
aPropertiesContainer- the property container
-