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
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
ConstructorsConstructorDescriptionCreates a JNDIConfiguration using the default initial context as the root of the properties.JNDIConfiguration(String prefix) Creates a JNDIConfiguration using the default initial context, shifted with the specified prefix, as the root of the properties.JNDIConfiguration(Context context) Creates a JNDIConfiguration using the specified initial context as the root of the properties.JNDIConfiguration(Context context, String prefix) Creates a JNDIConfiguration using the specified initial context shifted by the specified prefix as the root of the properties. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddPropertyDirect(String key, Object obj) This operation is not supported and will throw an UnsupportedOperationException.protected voidRemoves the specified property.protected booleanChecks whether the specified key is contained in this configuration.protected booleancontainsValueInternal(Object value) Tests whether this configuration contains one or more matches to this value.Gets the base context with the prefix applied.Gets the initial context used by this configuration.Gets an iterator with all property keys stored in this configuration.getKeysInternal(String prefix) Gets an iterator with all property keys starting with the given prefix.Gets the prefix.protected ObjectGets the value of the specified property.protected booleanReturns a flag whether this configuration is empty.voidsetContext(Context context) Sets the initial context of the configuration.voidSets the prefix.protected voidsetPropertyInternal(String key, 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, contains, containsKey, containsValue, 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, getKeys, getKeysInternal, 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, unlockMethods inherited from class org.apache.commons.configuration2.event.BaseEventSource
addEventListener, clearErrorListeners, clearEventListeners, clone, copyEventListeners, createErrorEvent, createEvent, fireError, fireEvent, getEventListenerRegistrations, getEventListeners, isDetailEvents, removeEventListener, setDetailEventsMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.configuration2.ImmutableConfiguration
getEnum, getEnum
-
Constructor Details
-
JNDIConfiguration
Creates a JNDIConfiguration using the default initial context as the root of the properties.- Throws:
NamingException- thrown if an error occurs when initializing the default context
-
JNDIConfiguration
Creates a JNDIConfiguration using the specified initial context as the root of the properties.- Parameters:
context- the initial context
-
JNDIConfiguration
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
-
JNDIConfiguration
Creates a JNDIConfiguration using the default initial context, shifted with the specified prefix, as the root of the properties.- Parameters:
prefix- the prefix- Throws:
NamingException- thrown if an error occurs when initializing the default context
-
-
Method Details
-
addPropertyDirect
This operation is not supported and will throw an UnsupportedOperationException.
- Specified by:
addPropertyDirectin classAbstractConfiguration- Parameters:
key- the keyobj- the value- Throws:
UnsupportedOperationException- always thrown as this method is not supported
-
clearPropertyDirect
Removes the specified property.- Specified by:
clearPropertyDirectin classAbstractConfiguration- Parameters:
key- the key of the property to remove
-
containsKeyInternal
Checks whether the specified key is contained in this configuration.- Specified by:
containsKeyInternalin classAbstractConfiguration- Parameters:
key- the key to check- Returns:
- a flag whether this key is stored in this configuration
-
containsValueInternal
Tests whether this configuration contains one or more matches to this value. This operation stops at first match but may be more expensive than the containsKey method.- Specified by:
containsValueInternalin classAbstractConfiguration- Parameters:
value- the value in question- Returns:
trueif and only if some key maps to thevalueargument in this configuration as determined by theequalsmethod;falseotherwise.- Since:
- 2.11.0
-
getBaseContext
Gets the base context with the prefix applied.- Returns:
- the base context
- Throws:
NamingException- if an error occurs
-
getContext
Gets the initial context used by this configuration. This context is independent of the prefix specified.- Returns:
- the initial context
-
getKeysInternal
Gets an iterator with all property keys stored in this configuration.- Specified by:
getKeysInternalin classAbstractConfiguration- Returns:
- an iterator with all keys
-
getKeysInternal
Gets an iterator with all property keys starting with the given prefix.- Overrides:
getKeysInternalin classAbstractConfiguration- Parameters:
prefix- the prefix- Returns:
- an iterator with the selected keys
-
getPrefix
Gets the prefix.- Returns:
- the prefix
-
getPropertyInternal
Gets the value of the specified property.- Specified by:
getPropertyInternalin classAbstractConfiguration- Parameters:
key- the key of the property- Returns:
- the value of this property
-
isEmptyInternal
Returns a flag whether this configuration is empty.- Specified by:
isEmptyInternalin classAbstractConfiguration- Returns:
- the empty flag
-
setContext
Sets the initial context of the configuration.- Parameters:
context- the context
-
setPrefix
Sets the prefix.- Parameters:
prefix- The prefix to set
-
setPropertyInternal
This operation is not supported and will throw an UnsupportedOperationException.
- Overrides:
setPropertyInternalin classAbstractConfiguration- Parameters:
key- the keyvalue- the value- Throws:
UnsupportedOperationException- always thrown as this method is not supported
-