org.settings4j.connector

Class JNDIConnector

java.lang.Object

org.settings4j.connector.AbstractConnector

org.settings4j.connector.JNDIConnector

All Implemented Interfaces:

Connector

public class JNDIConnector
extends AbstractConnector

The JNDI Context implementation of an Connector.

Normal Use

This JNDI connector is used in the default settings4j-config:

 <connector name="JNDIConnector"
     class="org.settings4j.connector.JNDIConnector">
     <contentResolver-ref ref="DefaultContentResolver" />
     <objectResolver-ref ref="DefaultObjectResolver" />
 </connector>
 

During the first use it will check if JNDI is accessible. If no JNDI context exists, The connector will deactivate itself. A INFO-Log message will print this information.

The default contextPathPrefix is "java:comp/env/". This JNDI Connector will first check if a value for "contextPathPrefix + key" exists and second if a value for the "key" only exists.

Custom Use

You can also configure the JNDI Connector to connect to another JNDI Context as the default one.

 <connector name="JNDIConnector"
     class="org.settings4j.connector.JNDIConnector">
     <param name="initialContextFactory" value="org.apache.naming.java.javaURLContextFactory"/>
     <param name="providerUrl" value="localhost:1099"/>
     <param name="urlPkgPrefixes" value="org.apache.naming"/>
 </connector>
 

All three parameters must be set "initialContextFactory", "providerUrl", "urlPkgPrefixes" if you want use another JNDI Context.

getString(), getContent(), getObject()

getString()

If the getString() JNDI lookup returns an Object which isn't a String, a WARN-Log message will be printed.

getContent()

If the getContent() JNDI lookup returns a String it will try to get a byte-Array Content from the ContentResolvers (assuming the String is as FileSystemPath or ClassPath).
Else if the getContent() JNDI lookup returns an Object which isn't a byte[], a WARN-Log message will be printed.

getObject()

If the getObject() JNDI lookup returns a String it will try to get an Object from the ObjectResolvers (assuming the String is as FileSystemPath or ClassPath which can be resolved to an Object).

Author:

Harald.Brabenetz

Constructor Summary

Constructors

Constructor and Description
JNDIConnector()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getContent(String key) return a byte[]-Value for the given key.
String	getContextPathPrefix()
protected Boolean	getIsJNDIAvailable()
Object	getObject(String key) return a Object-Value for the given key.
String	getString(String key) return a String-Value for the given key.
boolean	isJNDIAvailable() check if a JNDI context is available and sets the internal Flag setIsJNDIAvailable(Boolean).
int	rebindToContext(String key, Object value)
void	setContextPathPrefix(String contextPathPrefix)
void	setInitialContextFactory(String initialContextFactory)
protected void	setIsJNDIAvailable(Boolean isJNDIAvailable)
int	setObject(String key, Object value) Set or replace a new Value for the given key.
void	setProviderUrl(String providerUrl)
void	setUrlPkgPrefixes(String urlPkgPrefixes)

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

JNDIConnector

public JNDIConnector()

Method Detail

getContent

public 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

public 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.

getString

public 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

setObject

public int setObject(String key,
            Object value)

Set or replace a new Value for the given key.
If set or replace a value is not possible because of a readonly JNDI-Context, then Constants.SETTING_NOT_POSSIBLE must be returned. If set or replace was successful, then Constants.SETTING_SUCCESS must be returned.

Parameters:

key - the Key for the configuration-property (will not be normalized: add contextPathPrefix, replace '\' with '/'). e.g.: "com\mycompany\myapp\myParameterKey" => "java:comp/env/com/mycompany/myapp/myParameterKey"

value - the new Object-Value for the given key

Returns:

Returns Constants.SETTING_SUCCESS or Constants.SETTING_NOT_POSSIBLE

isJNDIAvailable

public boolean isJNDIAvailable()

check if a JNDI context is available and sets the internal Flag setIsJNDIAvailable(Boolean).

If the internal Flag IsJNDIAvailable is False this Connector is disabled.

Returns:

true if a JNDI Context could be initialized.

setProviderUrl

public void setProviderUrl(String providerUrl)

setInitialContextFactory

public void setInitialContextFactory(String initialContextFactory)

setUrlPkgPrefixes

public void setUrlPkgPrefixes(String urlPkgPrefixes)

rebindToContext

public int rebindToContext(String key,
                  Object value)

Parameters:

key - the JNDI-Key (will NOT be normalized).

value - the JNDI-Value.

Returns:

Constants.SETTING_NOT_POSSIBLE if the JNDI Context ist readonly.

getContextPathPrefix

public String getContextPathPrefix()

setContextPathPrefix

public void setContextPathPrefix(String contextPathPrefix)

getIsJNDIAvailable

protected Boolean getIsJNDIAvailable()

setIsJNDIAvailable

protected void setIsJNDIAvailable(Boolean isJNDIAvailable)