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
- Version:
- $Id: ServletContextConfiguration.java 1624601 2014-09-12 18:04:36Z oheger $
- Author:
- Emmanuel Bourg
-
-
Field Summary
Fields Modifier and Type Field Description protected javax.servlet.ServletContext
context
Stores 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 void
addPropertyDirect(java.lang.String key, java.lang.Object obj)
Adds a property to this configuration.protected void
clearPropertyDirect(java.lang.String key)
Removes the property with the given key.protected boolean
containsKeyInternal(java.lang.String key)
Checks whether the specified key is stored in this configuration.protected java.util.Iterator<java.lang.String>
getKeysInternal()
Actually creates an iterator for iterating over the keys in this configuration.protected java.lang.Object
getPropertyInternal(java.lang.String key)
Actually obtains the value of the specified property.protected java.lang.Object
handleDelimiters(java.lang.Object value)
Takes care of list delimiters in property values.protected boolean
isEmptyInternal()
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, 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
-
-
-
-
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 java.lang.Object getPropertyInternal(java.lang.String key)
Description copied from class:AbstractConfiguration
Actually 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:
getPropertyInternal
in classAbstractConfiguration
- Parameters:
key
- the key of the property in question- Returns:
- the (raw) value of this property
-
getKeysInternal
protected java.util.Iterator<java.lang.String> getKeysInternal()
Description copied from class:AbstractConfiguration
Actually 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:
getKeysInternal
in classAbstractConfiguration
- Returns:
- an
Iterator
with 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:
isEmptyInternal
in classAbstractConfiguration
- Returns:
- a flag whether this configuration is empty
-
containsKeyInternal
protected boolean containsKeyInternal(java.lang.String key)
Checks whether the specified key is stored in this configuration.- Specified by:
containsKeyInternal
in classAbstractConfiguration
- Parameters:
key
- the key- Returns:
- a flag whether this key exists in this configuration
-
clearPropertyDirect
protected void clearPropertyDirect(java.lang.String key)
Removes the property with the given key. This operation is not supported and will throw an UnsupportedOperationException.- Specified by:
clearPropertyDirect
in classAbstractConfiguration
- Parameters:
key
- the key of the property to be removed- Throws:
java.lang.UnsupportedOperationException
- because this operation is not allowed
-
addPropertyDirect
protected void addPropertyDirect(java.lang.String key, java.lang.Object obj)
Adds a property to this configuration. This operation is not supported and will throw an UnsupportedOperationException.- Specified by:
addPropertyDirect
in classAbstractConfiguration
- Parameters:
key
- the key of the propertyobj
- the value to be added- Throws:
java.lang.UnsupportedOperationException
- because this operation is not allowed
-
handleDelimiters
protected java.lang.Object handleDelimiters(java.lang.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
-
-