Class ServletContextConfiguration
- java.lang.Object
-
- org.apache.commons.configuration2.event.BaseEventSource
-
- org.apache.commons.configuration2.AbstractConfiguration
-
- org.apache.commons.configuration2.web.ServletContextConfiguration
-
- All Implemented Interfaces:
Configuration,EventSource,ImmutableConfiguration,SynchronizerSupport
public class ServletContextConfiguration extends AbstractConfiguration
A configuration wrapper to read the initialization parameters of a servlet context. This configuration is read only, adding or removing a property will throw an UnsupportedOperationException.- Since:
- 1.1
-
-
Field Summary
Fields Modifier and Type Field Description protected javax.servlet.ServletContextcontextStores the wrapped servlet context.
-
Constructor Summary
Constructors Constructor Description ServletContextConfiguration(javax.servlet.Servlet servlet)Create a ServletContextConfiguration using the context of the specified servlet.ServletContextConfiguration(javax.servlet.ServletContext context)Create a ServletContextConfiguration using the servlet context initialization parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddPropertyDirect(String key, Object obj)Adds a property to this configuration.protected voidclearPropertyDirect(String key)Removes the property with the given key.protected booleancontainsKeyInternal(String key)Checks whether the specified key is stored in this configuration.protected Iterator<String>getKeysInternal()Actually creates an iterator for iterating over the keys in this configuration.protected ObjectgetPropertyInternal(String key)Actually obtains the value of the specified property.protected ObjecthandleDelimiters(Object value)Takes care of list delimiters in property values.protected booleanisEmptyInternal()Checks if this configuration is empty.-
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, 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, setPropertyInternal, 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
-
-
-
-
Field Detail
-
context
protected javax.servlet.ServletContext context
Stores the wrapped servlet context.
-
-
Constructor Detail
-
ServletContextConfiguration
public ServletContextConfiguration(javax.servlet.Servlet servlet)
Create a ServletContextConfiguration using the context of the specified servlet.- Parameters:
servlet- the servlet
-
ServletContextConfiguration
public ServletContextConfiguration(javax.servlet.ServletContext context)
Create a ServletContextConfiguration using the servlet context initialization parameters.- Parameters:
context- the servlet context
-
-
Method Detail
-
getPropertyInternal
protected Object getPropertyInternal(String key)
Description copied from class:AbstractConfigurationActually obtains the value of the specified property. This method is called bygetProperty(). Concrete subclasses must define it to fetch the value of the desired property.- Specified by:
getPropertyInternalin classAbstractConfiguration- Parameters:
key- the key of the property in question- Returns:
- the (raw) value of this property
-
getKeysInternal
protected Iterator<String> getKeysInternal()
Description copied from class:AbstractConfigurationActually creates an iterator for iterating over the keys in this configuration. This method is called bygetKeys(), it has to be defined by concrete subclasses.- Specified by:
getKeysInternalin classAbstractConfiguration- Returns:
- an
Iteratorwith all property keys in this configuration
-
isEmptyInternal
protected boolean isEmptyInternal()
Checks if this configuration is empty. This implementation makes use of thegetKeys()method (which must be defined by concrete sub classes) to find out whether properties exist.- Specified by:
isEmptyInternalin classAbstractConfiguration- Returns:
- a flag whether this configuration is empty
-
containsKeyInternal
protected boolean containsKeyInternal(String key)
Checks whether the specified key is stored in this configuration.- Specified by:
containsKeyInternalin classAbstractConfiguration- Parameters:
key- the key- Returns:
- a flag whether this key exists in this configuration
-
clearPropertyDirect
protected void clearPropertyDirect(String key)
Removes the property with the given key. This operation is not supported and will throw an UnsupportedOperationException.- Specified by:
clearPropertyDirectin classAbstractConfiguration- Parameters:
key- the key of the property to be removed- Throws:
UnsupportedOperationException- because this operation is not allowed
-
addPropertyDirect
protected void addPropertyDirect(String key, Object obj)
Adds a property to this configuration. This operation is not supported and will throw an UnsupportedOperationException.- Specified by:
addPropertyDirectin classAbstractConfiguration- Parameters:
key- the key of the propertyobj- the value to be added- Throws:
UnsupportedOperationException- because this operation is not allowed
-
handleDelimiters
protected Object handleDelimiters(Object value)
Takes care of list delimiters in property values. This method checks if delimiter parsing is enabled and the passed in value contains a delimiter character. If this is the case, a split operation is performed.- Parameters:
value- the property value to be examined- Returns:
- the processed value
-
-