dk.heick.properties.io

Class WebContextParamsPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.WebContextParamsPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class WebContextParamsPropertyIO
extends AbstractPropertyIO

Loads the InitParameters defined by the ServletContext.getInitParameterNames() into a memory stored Properties instance.
The values are readonly and cached.

This is the context params in the web.xml.

Example:

 <?xml version="1.0" encoding="UTF-8"?>
 <web-app id="WebApp_ID" version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
                ...
                <context-param>
                        <description>This is a context parameter example</description>
                        <param-name>ContextParam</param-name>
                        <param-value>ContextParam value</param-value>
                </context-param>
                ...
 <web-app> 
 

Since:

1.1

Author:

Frederik Heick+

See Also:

ServletContext.getInitParameterNames(), ServletContext.getInitParameter(String), Properties, Serialized Form

Constructor Summary

Constructors

Constructor and Description
WebContextParamsPropertyIO(javax.servlet.ServletContext servletContext) Default constructor.

Method Summary

Modifier and Type	Method and Description
String	getName() A short descriptive name of the Property IO.
Properties	getProperties() Gets all the name,value pair in a Properties class instance.
javax.servlet.ServletContext	getServletContext() The servlet context which the property IO has beeen initialized.
String	getSource() Will return the "getServletContext().getContextPath()" if "getServletContext()" is null than "[NULL]" is returned.
void	setValue(String propertyName, String value) Sets the name,value as String in the IO.
void	validate() Validates the PropertyIO.

Methods inherited from class dk.heick.properties.io.AbstractPropertyIO

backup, getCacheTime, getLastLoaded, getLastSaved, getLogger, getTypedProperties, getTypedValue, getValue, isCached, isReadonly, logPerformanceGetProperties, logPerformanceSetValue, reload, setCacheTime, storeTypedValue, updateLastLoaded, updateLastSaved, validateWritable

Methods inherited from class java.lang.Object

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

Constructor Detail

WebContextParamsPropertyIO

public WebContextParamsPropertyIO(javax.servlet.ServletContext servletContext)

Default constructor. Both Readonly and Cached is true, see AbstractPropertyIO.

Parameters:

servletContext - the servlet context from wher the InitParameters are read.

See Also:

AbstractPropertyIO.AbstractPropertyIO(boolean, boolean)

Method Detail

getServletContext

public javax.servlet.ServletContext getServletContext()

The servlet context which the property IO has beeen initialized.

Returns:

the servlet context.

getName

public String getName()

Description copied from interface: PropertyIO

A short descriptive name of the Property IO.

Returns:

a short descriptive name of the PropertyIO class.

getSource

public String getSource()

Will return the "getServletContext().getContextPath()" if "getServletContext()" is null than "[NULL]" is returned.

Returns:

a data source description.

setValue

public void setValue(String propertyName,
                     String value)
              throws PropertyIOException

Description copied from interface: PropertyIO

Sets the name,value as String in the IO. Many IO implementations reloads when a value is set to refresh cache.
This is recommended, but the framework will update cache items with new values.

Parameters:

propertyName - the name of the property

value - the string value of the property.

Throws:

PropertyIOException - if the IO is readonly or failed to write the value.

validate

public void validate()
              throws PropertyIOException

Description copied from interface: PropertyIO

Validates the PropertyIO.

Throws:

PropertyIOException

getProperties

public Properties getProperties()

Description copied from interface: PropertyIO

Gets all the name,value pair in a Properties class instance.

Returns:

the Properties available for the IO.

See Also:

Properties