org.settings4j

Class Settings4j

java.lang.Object

org.settings4j.Settings4j

public final class Settings4j
extends Object

Settings is used to get simply access to Application settings.

 Example usage java:
 --------------------------------------
 public class SettingsManager {
     public static String getMyFormula() {
         return Settings4j.getString("com/mycompany/mycalculation/my-formula");
     }
 }
 --------------------------------------

 

Author:

Harald.Brabenetz

Method Summary

Modifier and Type	Method and Description
static Connector	getConnector(String connectorName) Return the Connector for the given Name.
static List<Connector>	getConnectors() Return a List off Connector who can be used with this Settings4j instance.
static byte[]	getContent(String key) return the found byte[]-Value for the given key.
static Object	getObject(String key) return the found Object-Value for the given key.
static Settings4jRepository	getSettingsRepository() Get the Settings4jRepository where this Settings-Object is stored.
static String	getString(String key) return the found String-Value for the given key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getString

public static String getString(String key)

return the found String-Value for the given key.
The Settings4j Instance iterates all his Connector and return the first found Value.

Returns null if no connector found a Value for the given key

If no custom settings4j.xml exist in classpath, the following default order will be used:

1. check if value for System.getProperty(String) exist (see SystemPropertyConnector ),
2. else check if value for InitialContext.lookup(String) exist (see JNDIConnector ),
3. else check if in Preferences.userRoot() and Preferences.systemRoot() the Value for Preferences.get(String, String) exist (see PreferencesConnector ),
4. else check if the value exist in Classpath (see ClasspathConnector ).

Parameters:

key - the Key for the configuration-property. e.g.: "com/mycompany/myapp/myParameterKey"

Returns:

the found String-Value for the given key

getContent

public static byte[] getContent(String key)

return the found byte[]-Value for the given key.

{ getSettings().getAllConnectors(); } The Settings4j Instance iterates all his Connector and return the first found Value.

Returns null if no connector found a Value for the given key

If no custom settings4j.xml exist in classpath, the behavior is like getString(String), but only the ClasspathConnector can return a byte[] content directly.
The other Connectors calls there getString(...) Method to get a valid Filesystempath or Classpath.

e.g SystemPropertyConnector:
Start the Application with -Dcom/mycompany/myapp/myParameterKey=file:D:/PathToMyFileContent
Then: getContent("com/mycompany/myapp/myParameterKey") will return the byte[] Content of "file:D:/PathToMyFileContent".

Valid Path-Prefixes are "file:" and "classpath:".
See ContentResolver and FSContentResolver and ClasspathContentResolver.

Parameters:

key - the Key for the configuration-property. e.g.: "com/mycompany/myapp/myParameterKey"

Returns:

the found byte[]-Value for the given key

getObject

public static Object getObject(String key)

return the found Object-Value for the given key.
The Settings4j Instance iterates all his Connector and return the first found Value.

Returns null if no connector found a Value for the given key

If no custom settings4j.xml exist in classpath, the behavior is like getString(String), but only the JNDIConnector can return an Object directly.
The other Connectors calls there getContent(...) Method to get a content which can be transformed to an Object.
See ObjectResolver.

Parameters:

key - the Key for the configuration-property. e.g.: "com/mycompany/myapp/myParameterKey"

Returns:

the found Object-Value for the given key

getSettingsRepository

public static Settings4jRepository getSettingsRepository()

Get the Settings4jRepository where this Settings-Object is stored.

Returns:

the Settings4jRepository where this Settings-Object is stored.

getConnectors

public static List<Connector> getConnectors()

Return a List off Connector who can be used with this Settings4j instance.

Returns:

a list off all Connectors who can be used with this Settings4j instance

getConnector

public static Connector getConnector(String connectorName)

Return the Connector for the given Name.

Parameters:

connectorName - The Connector Name.

Returns:

The Connector for the given Name.