Class JNDIConfiguration
- java.lang.Object
-
- org.apache.commons.configuration2.event.BaseEventSource
-
- org.apache.commons.configuration2.AbstractConfiguration
-
- org.apache.commons.configuration2.JNDIConfiguration
-
- All Implemented Interfaces:
Configuration
,EventSource
,ImmutableConfiguration
,SynchronizerSupport
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.
-
-
Constructor Summary
Constructors Constructor Description JNDIConfiguration()
Creates a JNDIConfiguration using the default initial context 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.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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addPropertyDirect(java.lang.String key, java.lang.Object obj)
This operation is not supported and will throw an UnsupportedOperationException.protected void
clearPropertyDirect(java.lang.String key)
Removes the specified property.protected boolean
containsKeyInternal(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.protected java.util.Iterator<java.lang.String>
getKeysInternal()
Returns an iterator with all property keys stored in this configuration.protected java.util.Iterator<java.lang.String>
getKeysInternal(java.lang.String prefix)
Returns an iterator with all property keys starting with the given prefix.java.lang.String
getPrefix()
Returns the prefix.protected java.lang.Object
getPropertyInternal(java.lang.String key)
Returns the value of the specified property.protected boolean
isEmptyInternal()
Returns a flag whether this configuration is empty.void
setContext(javax.naming.Context context)
Set the initial context of the configuration.void
setPrefix(java.lang.String prefix)
Sets the prefix.protected void
setPropertyInternal(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.configuration2.AbstractConfiguration
addErrorLogListener, addProperty, addPropertyInternal, append, beginRead, beginWrite, clear, clearInternal, clearProperty, cloneInterpolator, containsKey, copy, endRead, endWrite, get, get, getArray, getArray, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCollection, getCollection, getConfigurationDecoder, getConversionHandler, getDouble, getDouble, getDouble, getDuration, getDuration, getEncodedString, getEncodedString, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getKeys, getKeys, getList, getList, getList, getList, getListDelimiterHandler, getLogger, getLong, getLong, getLong, getProperties, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, getSynchronizer, immutableSubset, initLogger, installInterpolator, interpolate, interpolate, interpolatedConfiguration, isEmpty, isScalarValue, isThrowExceptionOnMissing, lock, setConfigurationDecoder, setConversionHandler, setDefaultLookups, setInterpolator, setListDelimiterHandler, setLogger, setParentInterpolator, setPrefixLookups, setProperty, setSynchronizer, setThrowExceptionOnMissing, size, sizeInternal, subset, unlock
-
Methods inherited from class org.apache.commons.configuration2.event.BaseEventSource
addEventListener, clearErrorListeners, clearEventListeners, clone, copyEventListeners, createErrorEvent, createEvent, fireError, fireEvent, getEventListenerRegistrations, getEventListeners, isDetailEvents, removeEventListener, setDetailEvents
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.commons.configuration2.ImmutableConfiguration
getEnum, getEnum
-
-
-
-
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 contextprefix
- the prefix
-
-
Method Detail
-
getKeysInternal
protected java.util.Iterator<java.lang.String> getKeysInternal()
Returns an iterator with all property keys stored in this configuration.- Specified by:
getKeysInternal
in classAbstractConfiguration
- Returns:
- an iterator with all keys
-
getKeysInternal
protected java.util.Iterator<java.lang.String> getKeysInternal(java.lang.String prefix)
Returns an iterator with all property keys starting with the given prefix.- Overrides:
getKeysInternal
in classAbstractConfiguration
- Parameters:
prefix
- the prefix- Returns:
- an iterator with the selected keys
-
isEmptyInternal
protected boolean isEmptyInternal()
Returns a flag whether this configuration is empty.- Specified by:
isEmptyInternal
in classAbstractConfiguration
- Returns:
- the empty flag
-
setPropertyInternal
protected void setPropertyInternal(java.lang.String key, java.lang.Object value)
This operation is not supported and will throw an UnsupportedOperationException.
- Overrides:
setPropertyInternal
in classAbstractConfiguration
- Parameters:
key
- the keyvalue
- the value- Throws:
java.lang.UnsupportedOperationException
- always thrown as this method is not supported
-
clearPropertyDirect
protected void clearPropertyDirect(java.lang.String key)
Removes the specified property.- Specified by:
clearPropertyDirect
in classAbstractConfiguration
- Parameters:
key
- the key of the property to remove
-
containsKeyInternal
protected boolean containsKeyInternal(java.lang.String key)
Checks whether the specified key is contained in this configuration.- Specified by:
containsKeyInternal
in classAbstractConfiguration
- 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
-
getPropertyInternal
protected java.lang.Object getPropertyInternal(java.lang.String key)
Returns the value of the specified property.- Specified by:
getPropertyInternal
in classAbstractConfiguration
- 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 classAbstractConfiguration
- Parameters:
key
- the keyobj
- the value- Throws:
java.lang.UnsupportedOperationException
- always thrown as this method is not supported
-
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
-
-