org.settings4j

Interface Settings4jInstance

All Known Implementing Classes:

DefaultSettings

public interface Settings4jInstance

SettingsInstance is used to get simply access to Application settings.

Author:

Harald.Brabenetz

See Also:

Settings4j

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnector(Connector connector) Add a Connector.
void	addConnector(Connector connector, ConnectorPosition position) Add a custom Connector to the right position in relation to the other connectors.
Connector	getConnector(String connectorName) Return the Connector for the given Name.
List<Connector>	getConnectors() Return a List off Connector who can be used with this Settings4jInstance instance.
byte[]	getContent(String key) return the found byte[]-Value for the given key.
Map	getMapping() The key mapping defined in settings4j.xml.
Object	getObject(String key) return the found Object-Value for the given key.
String	getString(String key) return the found String-Value for the given key.
void	removeAllConnectors() Remove all Settings.
void	setMapping(Map mapping) Set the mapping for this Settings-Object without inheritance.

Method Detail

getString

String getString(String key)

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

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

Parameters:

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

Returns:

the found String-Value for the given key

getContent

byte[] getContent(String key)

return the found byte[]-Value for the given key.
The Settings4jInstance Instance iterates all his Connectors and return the first found Value.

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

Parameters:

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

Returns:

the found byte[]-Value for the given key

getObject

Object getObject(String key)

return the found Object-Value for the given key.
The Settings4jInstance iterates all his Connectors and return the first found Value.
Returns null if no connector found a Value for the given key

Parameters:

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

Returns:

the found Object-Value for the given key

addConnector

void addConnector(Connector connector)

Add a Connector.
This method will be call, if you create a connector-ref to a connector configuration in your settings4j.xml

 Example configuration in settings4j.xml:
 --------------------------------------
 <settings name="com.mycompany" >
     <connector-ref name="DBConnector" />
 </settings>
 --------------------------------------
 

Parameters:

connector - The connector to add.

addConnector

void addConnector(Connector connector,
                ConnectorPosition position)

Add a custom Connector to the right position in relation to the other connectors.
This method can be used to add custom connectors into the Settings4jInstance

Example usage 1:

 --------------------------------------
 Connector myConnector = ...
 addConnector(myConnector, ConnectorPositions.afterLast(SystemPropertyConnector.class));
 --------------------------------------
 

Example usage 2:

ConnectorPositions.afterLast(SystemPropertyConnector.class) will throw an exception if the Settings4jInstance doesn't have a SystemPropertyConnector.
To prevent an Exception you can provide multiple ConnectorPositions as fallback:

 --------------------------------------
 Connector myConnector = ...
 addConnector(myConnector, ConnectorPositions.firstValid(//
     ConnectorPositions.afterLast(SystemPropertyConnector.class),
     ConnectorPositions.atFirst() // fallback if no SystemPropertyConnector exists.
   )
 );
 --------------------------------------
 

Example usage 3:

addConnector(Connector) will throw an exception if a connector with the same name already exists.
To prevent this Exception you should also check with getConnector(String) if the Connector already exists:

 --------------------------------------
 Connector myConnector = ...
 if(getConnector(myConnector.getName()) == null) {
   addConnector(myConnector, ConnectorPositions.firstValid(//
       ConnectorPositions.afterLast(SystemPropertyConnector.class),
       ConnectorPositions.atFirst() // fallback if no SystemPropertyConnector exists.
     )
   );
 }
 --------------------------------------
 

Parameters:

connector - The connector to add.

position - The position where the connector should be added.

removeAllConnectors

void removeAllConnectors()

Remove all Settings. (Internal use only)

getMapping

Map getMapping()

The key mapping defined in settings4j.xml.

if some Sub-Modules of your App defines separated Keys for e.g. the DataSource, you can refer it to one unique Key:

 Example:
 <mapping name="defaultMapping">
     <entry key="com/mycompany/moduleX/datasource" ref-key="global/datasource"/>
     <entry key="com/mycompany/moduleY/datasource" ref-key="global/datasource"/>
 </mapping>
 

Settings4j.getXXX("com/mycompany/moduleX/datasource");
should return the configured value under "global/datasource"

Returns:

the Mappings of this Settings-Object (without inheritances)

setMapping

void setMapping(Map mapping)

Set the mapping for this Settings-Object without inheritance.
This method will be call, if you create a mapping-ref to a mapping configuration in your settings4j.xml

 Example:
 <root mapping-ref="defaultMapping" >
    ...
 </root>
 
 <mapping name="defaultMapping">
     <entry key="com/mycompany/moduleX/datasource" ref-key="global/datasource"/>
     <entry key="com/mycompany/moduleY/datasource" ref-key="global/datasource"/>
 </mapping>
 

Parameters:

mapping - The Mapping between available settings to used settings.

getConnectors

List<Connector> getConnectors()

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

Returns:

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

getConnector

Connector getConnector(String connectorName)

Return the Connector for the given Name.

Parameters:

connectorName - The Connector Name.

Returns:

The Connector for the given Name.