org.settings4j

Interface Connector

All Known Implementing Classes:

AbstractConnector, AbstractPropertyConnector, CachedConnectorWrapper, ClasspathConnector, ConfigurationToConnectorAdapter, EnvironmentConnector, FilteredConnectorWrapper, FSConnector, JNDIConnector, PreferencesConnector, PropertyFileConnector, SystemPropertyConnector

public interface Connector

An implementation of this Interface can return Values for a given key.
Not every implementation can write a value for a given key (e.g.: ClasspathConnector )
String, byte[] (content) and Objects should be possible.

A Connector can use the Helper Implementations ContentResolver and ObjectResolver for internal use.
Not ervery Connector needs them, Read the Javadoc of the concrete implementaiton.

 
 Example configuration in settings4j.xml:
 --------------------------------------
 <connector name="ClasspathConnector" class="org.settings4j.connector.ClasspathConnector" >
     <objectResolver-ref ref="DefaultObjectResolver" />
 </connector>
 --------------------------------------
 
 

Author:

Harald.Brabenetz

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnector(Connector connector) Add a Connector if you needed inside the init() Methode.
byte[]	getContent(String key) return a byte[]-Value for the given key.
String	getName() Return The name Of this Connector.
Object	getObject(String key) return a Object-Value for the given key.
String	getString(String key) return a String-Value for the given key.
void	init() Will be called after all properties have been set.
void	setContentResolver(ContentResolver contentResolver) set a ContentResolver as Helper for getContent(String).
void	setName(String name) Set the name of the Connector defined in the settings4j.xml configuration: -------------------------------------- <connector name="PropertyFileConnector" ....
void	setObjectResolver(ObjectResolver objectResolver) set a ObjectResolver as Helper for getObject(String).

Method Detail

getString

String getString(String key)

return a String-Value for the given key.

Parameters:

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

Returns:

the String-Value for the given key

getContent

byte[] getContent(String key)

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

The concrete implementation can use the ContentResolver if required

Parameters:

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

Returns:

the byte[]-Value for the given key

getObject

Object getObject(String key)

return a Object-Value for the given key.

The concrete implementation can use the ObjectResolver if required

Parameters:

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

Returns:

the Object-Value for the given key, or null if no value where found.

setContentResolver

void setContentResolver(ContentResolver contentResolver)

set a ContentResolver as Helper for getContent(String).

Parameters:

contentResolver - the ContentResolver to set.

setObjectResolver

void setObjectResolver(ObjectResolver objectResolver)

set a ObjectResolver as Helper for getObject(String).

Parameters:

objectResolver - the ObjectResolver to set.

addConnector

void addConnector(Connector connector)

Add a Connector if you needed inside the init() Methode.
Or you can use this connectors inside the settings4j.xml to set a parameter/property

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

Parameters:

connector - the Connector to set.

init

void init()

Will be called after all properties have been set. This function will only called one times.

getName

String getName()

Return The name Of this Connector. The Name is required in all Settings4j.set*(..., String connectorName) Methods.

Returns:

The name Of this Connector.

setName

void setName(String name)

Set the name of the Connector defined in the settings4j.xml configuration:

 --------------------------------------
 <connector name="PropertyFileConnector" ....>
     ....
 </connector>
 --------------------------------------
 

Parameters:

name - the Name of this Connector.