org.settings4j.helper.configuration

Class ConfigurationToConnectorAdapter

java.lang.Object

org.settings4j.connector.AbstractConnector

org.settings4j.connector.AbstractPropertyConnector

org.settings4j.helper.configuration.ConfigurationToConnectorAdapter

All Implemented Interfaces:

Connector

public class ConfigurationToConnectorAdapter
extends AbstractPropertyConnector

Adapter to use an Apache Commons Configuration as Settings4j connector.

Example Usage

Create a XMLConfiguration instance and add it to the Settings4j instance as Connector.

 String connectorName = "myCommonsConfigXmlConfigConnector";
 Connector connector =  Settings4j.getSettings().getConnector(connectorName);
 if (connector == null) {
     XMLConfiguration configuration = new XMLConfiguration(new File(.....));

     connector = new ConfigurationToConnectorAdapter(connectorName, configuration);

     // add the connecter after the last SystemPropertyConnector or add it as first connector.
     Settings4j.getSettings().addConnector(connector, //
         ConnectorPositions.firstValid(//
             ConnectorPositions.afterLast(SystemPropertyConnector.class), //
             ConnectorPositions.atFirst() // if no SystemPropertyConnector is configured.
             )//
         );
 }
 

Author:

brabenetz

Constructor Summary

Constructors

Constructor and Description
ConfigurationToConnectorAdapter(String name, org.apache.commons.configuration.Configuration configuration)

Method Summary

Modifier and Type	Method and Description
org.apache.commons.configuration.Configuration	getConfiguration()
String	getString(String key) return a String-Value for the given key.

Methods inherited from class org.settings4j.connector.AbstractPropertyConnector

getContent, getObject

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

ConfigurationToConnectorAdapter

public ConfigurationToConnectorAdapter(String name,
                                       org.apache.commons.configuration.Configuration configuration)

Parameters:

name - The unique name of this connector.

configuration - The apache commons configuration instance to wrap and use as Settings4j connector.

Method Detail

getString

public String getString(String key)

Description copied from interface: Connector

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

getConfiguration

public org.apache.commons.configuration.Configuration getConfiguration()