org.settings4j.connector

Class CachedConnectorWrapper

java.lang.Object

org.settings4j.connector.CachedConnectorWrapper

All Implemented Interfaces:

Connector

public class CachedConnectorWrapper
extends Object
implements Connector

Wrap a Connector and caches all Values.

This wrapper will be used if you add in your settings4j.xml the cached="true" Attribute to the Connector TAG.

Author:

Harald.Brabenetz

Constructor Summary

Constructors

Constructor and Description
CachedConnectorWrapper(Connector targetConnector)

Method Summary

Modifier and Type	Method and Description
void	addConnector(Connector connector) Add a Connector if you needed inside the Connector.init() Methode.
void	clearCachedValue(String key)
byte[]	getContent(String key) return a byte[]-Value for the given key or null if no file-content for the key where found.
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 Connector.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 Connector.getObject(String).

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedConnectorWrapper

public CachedConnectorWrapper(Connector targetConnector)

Parameters:

targetConnector - The connector to wrap.

Method Detail

getContent

public byte[] getContent(String key)

Description copied from interface: Connector

return a byte[]-Value for the given key or null if no file-content for the key where found.

The concrete implementation can use the ContentResolver if required

Specified by:

getContent in interface Connector

Parameters:

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

Returns:

the byte[]-Value for the given key

getObject

public Object getObject(String key)

Description copied from interface: Connector

return a Object-Value for the given key.

The concrete implementation can use the ObjectResolver if required

Specified by:

getObject in interface Connector

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.

getString

public String getString(String key)

Description copied from interface: Connector

return a String-Value for the given key.

Specified by:

getString in interface Connector

Parameters:

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

Returns:

the String-Value for the given key

clearCachedValue

public void clearCachedValue(String key)

Parameters:

key - the key to clear from all caches.

addConnector

public void addConnector(Connector connector)

Description copied from interface: Connector

Add a Connector if you needed inside the Connector.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>
 --------------------------------------
 

Specified by:

addConnector in interface Connector

Parameters:

connector - the Connector to set.

setContentResolver

public void setContentResolver(ContentResolver contentResolver)

Description copied from interface: Connector

set a ContentResolver as Helper for Connector.getContent(String).

Specified by:

setContentResolver in interface Connector

Parameters:

contentResolver - the ContentResolver to set.

setObjectResolver

public void setObjectResolver(ObjectResolver objectResolver)

Description copied from interface: Connector

set a ObjectResolver as Helper for Connector.getObject(String).

Specified by:

setObjectResolver in interface Connector

Parameters:

objectResolver - the ObjectResolver to set.

init

public void init()

Description copied from interface: Connector

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

Specified by:

init in interface Connector

getName

public String getName()

Description copied from interface: Connector

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

Specified by:

getName in interface Connector

Returns:

The name Of this Connector.

setName

public void setName(String name)

Description copied from interface: Connector

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

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

Specified by:

setName in interface Connector

Parameters:

name - the Name of this Connector.