org.apache.commons.configuration
Class JNDIConfiguration

java.lang.Object
  org.apache.commons.configuration.event.EventSource
      org.apache.commons.configuration.AbstractConfiguration
          org.apache.commons.configuration.JNDIConfiguration

All Implemented Interfaces:

Configuration

public class JNDIConfiguration
extends AbstractConfiguration

This Configuration class allows you to interface with a JNDI datasource. A JNDIConfiguration is read-only, write operations will throw an UnsupportedOperationException. The clear operations are supported but the underlying JNDI data source is not changed.

Version:

$Id: JNDIConfiguration.java 549591 2007-06-21 19:57:25Z oheger $

Author:

Eric Pugh

Field Summary

private javax.naming.Context	baseContext The base JNDI context.
private java.util.Set	clearedProperties The Set of keys that have been virtually cleared.
private javax.naming.Context	context The initial JNDI context.
private java.lang.String	prefix The prefix of the context.

Fields inherited from class org.apache.commons.configuration.AbstractConfiguration

END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN

Constructor Summary

JNDIConfiguration()
Creates a JNDIConfiguration using the default initial context as the root of the properties.

JNDIConfiguration(javax.naming.Context context)
Creates a JNDIConfiguration using the specified initial context as the root of the properties.

JNDIConfiguration(javax.naming.Context context, java.lang.String prefix)
Creates a JNDIConfiguration using the specified initial context shifted by the specified prefix as the root of the properties.

JNDIConfiguration(java.lang.String prefix)
Creates a JNDIConfiguration using the default initial context, shifted with the specified prefix, as the root of the properties.

Method Summary

protected void	addPropertyDirect(java.lang.String key, java.lang.Object obj) This operation is not supported and will throw an UnsupportedOperationException.
void	clearProperty(java.lang.String key) Removes the specified property.
boolean	containsKey(java.lang.String key) Checks whether the specified key is contained in this configuration.
javax.naming.Context	getBaseContext() Return the base context with the prefix applied.
javax.naming.Context	getContext() Return the initial context used by this configuration.
private javax.naming.Context	getContext(java.util.List path, javax.naming.Context context) Because JNDI is based on a tree configuration, we need to filter down the tree, till we find the Context specified by the key to start from.
java.util.Iterator	getKeys() Returns an iterator with all property keys stored in this configuration.
java.util.Iterator	getKeys(java.lang.String prefix) Returns an iterator with all property keys starting with the given prefix.
java.lang.String	getPrefix() Returns the prefix.
java.lang.Object	getProperty(java.lang.String key) Returns the value of the specified property.
boolean	isEmpty() Returns a flag whether this configuration is empty.
private void	recursiveGetKeys(java.util.Set keys, javax.naming.Context context, java.lang.String prefix, java.util.Set processedCtx) This method recursive traverse the JNDI tree, looking for Context objects.
void	setContext(javax.naming.Context context) Set the initial context of the configuration.
void	setPrefix(java.lang.String prefix) Sets the prefix.
void	setProperty(java.lang.String key, java.lang.Object value) This operation is not supported and will throw an UnsupportedOperationException.

Methods inherited from class org.apache.commons.configuration.AbstractConfiguration

addErrorLogListener, addProperty, append, clear, clearPropertyDirect, copy, createInterpolator, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getList, getList, getListDelimiter, getLogger, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, getSubstitutor, interpolate, interpolate, interpolatedConfiguration, interpolateHelper, isDelimiterParsingDisabled, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setDelimiterParsingDisabled, setListDelimiter, setLogger, setThrowExceptionOnMissing, subset

Methods inherited from class org.apache.commons.configuration.event.EventSource

addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, clone, createErrorEvent, createEvent, fireError, fireEvent, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents

Methods inherited from class java.lang.Object

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

Field Detail

prefix

private java.lang.String prefix

The prefix of the context.

context

private javax.naming.Context context

The initial JNDI context.

baseContext

private javax.naming.Context baseContext

The base JNDI context.

clearedProperties

private java.util.Set clearedProperties

The Set of keys that have been virtually cleared.

Constructor Detail

JNDIConfiguration

public JNDIConfiguration()
                  throws javax.naming.NamingException

Creates a JNDIConfiguration using the default initial context as the root of the properties.

Throws:

javax.naming.NamingException - thrown if an error occurs when initializing the default context

JNDIConfiguration

public JNDIConfiguration(java.lang.String prefix)
                  throws javax.naming.NamingException

Creates a JNDIConfiguration using the default initial context, shifted with the specified prefix, as the root of the properties.

Parameters:

prefix - the prefix

Throws:

javax.naming.NamingException - thrown if an error occurs when initializing the default context

JNDIConfiguration

public JNDIConfiguration(javax.naming.Context context)

Creates a JNDIConfiguration using the specified initial context as the root of the properties.

Parameters:

context - the initial context

JNDIConfiguration

public JNDIConfiguration(javax.naming.Context context,
                         java.lang.String prefix)

Creates a JNDIConfiguration using the specified initial context shifted by the specified prefix as the root of the properties.

Parameters:

context - the initial context

prefix - the prefix

Method Detail

recursiveGetKeys

private void recursiveGetKeys(java.util.Set keys,
                              javax.naming.Context context,
                              java.lang.String prefix,
                              java.util.Set processedCtx)
                       throws javax.naming.NamingException

This method recursive traverse the JNDI tree, looking for Context objects. When it finds them, it traverses them as well. Otherwise it just adds the values to the list of keys found.

Parameters:

keys - All the keys that have been found.

context - The parent context

prefix - What prefix we are building on.

processedCtx - a set with the so far processed objects

Throws:

javax.naming.NamingException - If JNDI has an issue.

getKeys

public java.util.Iterator getKeys()

Returns an iterator with all property keys stored in this configuration.

Returns:

an iterator with all keys

getKeys

public java.util.Iterator getKeys(java.lang.String prefix)

Returns an iterator with all property keys starting with the given prefix.

Specified by:

getKeys in interface Configuration

Overrides:

getKeys in class AbstractConfiguration

Parameters:

prefix - the prefix

Returns:

an iterator with the selected keys

See Also:

Configuration.getKeys()

getContext

private javax.naming.Context getContext(java.util.List path,
                                        javax.naming.Context context)
                                 throws javax.naming.NamingException

Because JNDI is based on a tree configuration, we need to filter down the tree, till we find the Context specified by the key to start from. Otherwise return null.

Parameters:

path - the path of keys to traverse in order to find the context

context - the context to start from

Returns:

The context at that key's location in the JNDI tree, or null if not found

Throws:

javax.naming.NamingException - if JNDI has an issue

isEmpty

public boolean isEmpty()

Returns a flag whether this configuration is empty.

Returns:

the empty flag

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

This operation is not supported and will throw an UnsupportedOperationException.

Specified by:

setProperty in interface Configuration

Overrides:

setProperty in class AbstractConfiguration

Parameters:

key - the key

value - the value

Throws:

java.lang.UnsupportedOperationException

clearProperty

public void clearProperty(java.lang.String key)

Removes the specified property.

Specified by:

clearProperty in interface Configuration

Overrides:

clearProperty in class AbstractConfiguration

Parameters:

key - the key of the property to remove

containsKey

public boolean containsKey(java.lang.String key)

Checks whether the specified key is contained in this configuration.

Parameters:

key - the key to check

Returns:

a flag whether this key is stored in this configuration

getPrefix

public java.lang.String getPrefix()

Returns the prefix.

Returns:

the prefix

setPrefix

public void setPrefix(java.lang.String prefix)

Sets the prefix.

Parameters:

prefix - The prefix to set

getProperty

public java.lang.Object getProperty(java.lang.String key)

Returns the value of the specified property.

Parameters:

key - the key of the property

Returns:

the value of this property

addPropertyDirect

protected void addPropertyDirect(java.lang.String key,
                                 java.lang.Object obj)

This operation is not supported and will throw an UnsupportedOperationException.

Specified by:

addPropertyDirect in class AbstractConfiguration

Parameters:

key - the key

obj - the value

Throws:

java.lang.UnsupportedOperationException

getBaseContext

public javax.naming.Context getBaseContext()
                                    throws javax.naming.NamingException

Return the base context with the prefix applied.

Returns:

the base context

Throws:

javax.naming.NamingException - if an error occurs

getContext

public javax.naming.Context getContext()

Return the initial context used by this configuration. This context is independent of the prefix specified.

Returns:

the initial context

setContext

public void setContext(javax.naming.Context context)

Set the initial context of the configuration.

Parameters:

context - the context