Class FWImagePropertyProvider

java.lang.Object
net.simplace.core.property.FWImagePropertyProvider

public final class FWImagePropertyProvider extends Object
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.

Works with Java .properties files on the classpath. Changed values are written to a cache file in ~/tmp/properties, which is read instead of the original file afterwards. The original values stay available (see getOriginalProperty(String, String, String)).

Author:
Andreas Enders
  • Method Details

    • getInstance

      public static FWImagePropertyProvider getInstance()
      Returns:
      Singleton instance of PropertyProvider.
    • flushPropertySet

      public boolean flushPropertySet(String aPropertySet)
      Flush a property set, i.e. delete it from memory and also reset the entries in the cache file. This allows runtime modifications of property files using external tools, because it forces the resource manager to re-read the properties from the original file. Returns true if flushing is successful and false if flushing fails.
      Parameters:
      aPropertySet - name of the property set
      Returns:
      true if successful (also if there was no cache file)
    • flushProperty

      public boolean flushProperty(String aPropertySet, String aKey)
      Resets one property to its value in the original file (the cache file is updated).
      Parameters:
      aPropertySet - name of the property set
      aKey - the property key
      Returns:
      false on errors, otherwise true (also if there is no original value)
    • getProperty

      public String getProperty(String aPropertySet, String aKey, String aDefault)
      Get the value of a property in a specific set. If the set doesn't contain a value for the given property return the specified default value.
      Parameters:
      aPropertySet - name of the property set
      aKey - the property key
      aDefault - value returned if the property is missing
      Returns:
      the property value with system variables replaced, or the default
    • getProperty

      public String getProperty(String aPropertySet, String aKey)
      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 null (a warning is logged).
      Parameters:
      aPropertySet - name of the property set
      aKey - the property key
      Returns:
      the property value with system variables replaced, or null
    • getOriginalProperty

      public String getOriginalProperty(String aPropertySet, String aKey, String aDefault)
      Get the value of a property in a specific set. If the set doesn't contain a value for the given property return the specified default value. The value is read from the original file, not from the cache file.
      Parameters:
      aPropertySet - name of the property set
      aKey - the property key
      aDefault - value returned if the property is missing
      Returns:
      the original property value with system variables replaced, or the default
    • getOriginalPropertySet

      public Properties getOriginalPropertySet(String aPropertySetName)
      Get a specific property set, by replacing the System variables in the values. Mostly used in the clients to cache the whole property set.
      Parameters:
      aPropertySetName - name of the property set
      Returns:
      a copy of the original property set with system variables replaced, or null if not found
    • getSystemEnvironmentVariable

      public String getSystemEnvironmentVariable(String aKey)
      Get the value of for the given property or if the Returns an environment variable, or else the Java system property with this name.
      Parameters:
      aKey - the variable name
      Returns:
      the value, or null if neither exists or the key is null
    • getSystemRegistryVariable

      public static String getSystemRegistryVariable(String aKey)
      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) null is returned. Windows registry values are stored by root key and path. The parameter registryKey contains the following format: ROOT_KEY\PATH\VALUE for a specific value or ROOT_KEY\PATH\ to return the default value. Example registryKey values: HKEY_CURRENT_USER\Environment\JAVA_HOME HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Internet Explorer\Search\SearchAssistant HKEY_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_USERS Calling getSystemRegistryVariable("HKEY_CLASSES_ROOT\Shell\shell\open\command\") would return %SystemRoot%\Explorer.exe /idlist,%I,%L on a typical Windows installation.
      Parameters:
      aKey - the registry key ROOT_KEY\PATH\VALUE
      Returns:
      the registry value, or null
    • getJavaRuntimeVariable

      public static String getJavaRuntimeVariable(String aKey)
      Returns a Java system property with forward slashes.
      Parameters:
      aKey - name of the system property
      Returns:
      the value (a NullPointerException is thrown for unknown properties)
    • setSystemEnvironmentVariable

      @Deprecated public static boolean setSystemEnvironmentVariable(String aKey, String aValue)
      Deprecated.
      has no effect
      Not supported: a Java process cannot change its own environment variables (running set in a shell only affected that child process). A warning is logged.
      Parameters:
      aKey - the variable name
      aValue - the value
      Returns:
      always false
    • setProperty

      public boolean setProperty(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. 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 return false like in any other case of an error.
      Parameters:
      aPropertySet - name of the property set
      aKey - the property key (must exist)
      aValue - the new value; null removes the property
      Returns:
      true if the cache file was written
    • setProperty

      public boolean setProperty(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. 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 return false like in any other case of an error. The property set is written to its cache file; line breaks are stored as \n.
      Parameters:
      aPropertySet - name of the property set
      aKey - the property key
      aValue - the new value; null removes the property
      aNewValue - true to allow adding a new key
      Returns:
      true if the cache file was written
    • setPropertyToOriginalFile

      public boolean setPropertyToOriginalFile(String aPropertySet, String aKey, String aValue)
      Set the value for a specified key within a specified property set original location and make those settings persistent.No restarting of application is required. 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 return false like in any other case of an error. Cannot be used if the original file is in a jar-file. The file is rewritten line by line, only the line of the key is changed.
      Parameters:
      aPropertySet - name of the property set
      aKey - the property key (must exist)
      aValue - the new value
      Returns:
      true if the original file was written
    • getProperties

      public Properties getProperties(String aPropertySet)
      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 complete Properties object (from the cache file if present), or null if not found
    • getPropertyNames

      public Enumeration<String> getPropertyNames(String aPropertySet)
      Parameters:
      aPropertySet - name of the property set
      Returns:
      an Enumeration of the property names contained in the specified property set, or null if the property set can't be found
    • getOriginalPropertyNames

      public Enumeration<String> getOriginalPropertyNames(String aPropertySet)
      Parameters:
      aPropertySet - name of the property set
      Returns:
      an Enumeration of the property names contained in the original file, or null if the property set can't be found
    • getPropertySetURL

      public URL getPropertySetURL(String aPropertySet)
      Parameters:
      aPropertySet - name of the property set
      Returns:
      the URL of the original file of the property set, or null if it can't be found
    • getEnvVars

      public Properties getEnvVars()
      Returns:
      the environment-variables.
    • replaceSystemVariables

      public String replaceSystemVariables(String aPropertyValue)
      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

      public String getPropertiesAsString(String aPropertyset)
      Parameters:
      aPropertyset - name of the property set
      Returns:
      the property set as Properties.toString(), or "null" if not found