org.settings4j.connector

Class PropertyFileConnector

java.lang.Object

org.settings4j.connector.AbstractConnector

org.settings4j.connector.AbstractPropertyConnector

org.settings4j.connector.PropertyFileConnector

All Implemented Interfaces:

Connector

public class PropertyFileConnector
extends AbstractPropertyConnector

The Properties-File implementation of an Connector.

Example usage read property File from Classpath with ClasspathConnector (<param name="propertyFromContent" ... />):

 <settings4j:configuration xmlns:settings4j='http://settings4j.org/'>
 
     <connector name="PropertyFileConnector" class="org.settings4j.connector.PropertyFileConnector">
         <param  name="propertyFromContent"
                 value="${connectors.content['org/settings4j/config/propertyFile.properties']}" />
         <connector-ref ref="ClasspathConnector" />
     </connector>
     
     <connector name="ClasspathConnector"
         class="org.settings4j.connector.ClasspathConnector" />
 
 </settings4j:configuration>
 

You can also use other connectors which have a nativ implementation for Connector.getContent(String) (doesn't use contentResolver).
e.g.: FSConnector for FileSystem paths.

Example usage read property File from Classpath with ClasspathConnector:

If you don't like ExpressionLanguage, then you can set the path to your PropertyFile directly. But in this case a prefix "file:" or "classpath" is required. And only "file:" and "classpath" are supported.
Example usage read property File from Classpath with classpathString (<param name="propertyFromPath" ... />):

 <settings4j:configuration xmlns:settings4j='http://settings4j.org/'>
 
     <connector name="PropertyFileConnector" class="org.settings4j.connector.PropertyFileConnector">
         <param  name="propertyFromPath"
                 value="classpath:org/settings4j/config/propertyFile.properties" />
     </connector>
 
 </settings4j:configuration>
 

Author:

Harald.Brabenetz

Constructor Summary

Constructors

Constructor and Description
PropertyFileConnector()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getProperty(String key, String def) Very similar to System.getProperty except that the SecurityException is hidden.
void	setProperty(Properties property)
void	setPropertyFromContent(byte[] content)
void	setPropertyFromPath(String propertyPath)

Methods inherited from class org.settings4j.connector.AbstractPropertyConnector

getContent, getObject, getString

Methods inherited from class org.settings4j.connector.AbstractConnector

addConnector, getConnectors, getContentResolver, getName, getObjectResolver, init, setContentResolver, setName, setObjectResolver

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyFileConnector

public PropertyFileConnector()

Method Detail

getProperty

protected String getProperty(String key,
                 String def)

Very similar to System.getProperty except that the SecurityException is hidden.

Specified by:

getProperty in class AbstractPropertyConnector

Parameters:

key - The key to search for.

def - The default value to return.

Returns:

the string value of the system property, or the default value if there is no property with that key.

setProperty

public void setProperty(Properties property)

setPropertyFromContent

public void setPropertyFromContent(byte[] content)

Parameters:

content - The byte[] Content of a Property-File.

setPropertyFromPath

public void setPropertyFromPath(String propertyPath)

Parameters:

propertyPath - The filepath to a Property-File. Supported prefixes: "file:" and "classpath:".