dk.heick.properties.io

Class ServletContextPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.ServletContextPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class ServletContextPropertyIO
extends AbstractPropertyIO

Loads the property file from a file, resolving the path with getServletContext().getRealPath(getResourceName()).
This is can only be used in a servlet context situation aka a web server.

Author:

Frederik Heick

See Also:

ServletContext.getRealPath(String), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ServletContextPropertyIO(javax.servlet.ServletContext servletContext, String resourceName) Minimum constructor where "cache" is set to true and "readonly" is false.
ServletContextPropertyIO(javax.servlet.ServletContext servletContext, String resourceName, boolean readonly) Constructor where "cache" is set to true.
ServletContextPropertyIO(javax.servlet.ServletContext servletContext, String resourceName, boolean readonly, boolean cache) Main constructor with all the attributes.

Method Summary

Modifier and Type	Method and Description
protected File	getFile() The file that the servlet context has resolved the resourceName to via the ServletContext.getRealPath(String) method.
String	getName() A short descriptive name of the Property IO.
Properties	getProperties() Gets all the name,value pair in a Properties class instance.
String	getResourceName() The resource file the ServletContextPropertyIO is looking for.
javax.servlet.ServletContext	getServletContext() The servlet context that the ServletContextPropertyIO has been initialized with.
String	getSource() A detailed description of the source of the property data.
void	reload() Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time.
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, 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

ServletContextPropertyIO

public ServletContextPropertyIO(javax.servlet.ServletContext servletContext,
                                String resourceName,
                                boolean readonly,
                                boolean cache)

Main constructor with all the attributes.

Parameters:

servletContext - the servletContext.

resourceName - the name of the file or part of the directory and name of the file, which servletContext will resolve to a file to be loaded.

readonly - is the ServletContextPropertyIO to be read only.

cache - shall the values be cached in the PropertyIO's.

See Also:

ServletContext.getRealPath(String)

ServletContextPropertyIO

public ServletContextPropertyIO(javax.servlet.ServletContext servletContext,
                                String resourceName,
                                boolean readonly)

Constructor where "cache" is set to true.

Parameters:

servletContext - the servletContext.

resourceName - the name of the file or part of the directory and name of the file, which servletContext will resolve to a file to be loaded.

readonly - is the ServletContextPropertyIO to be read only.

See Also:

ServletContext.getRealPath(String)

ServletContextPropertyIO

public ServletContextPropertyIO(javax.servlet.ServletContext servletContext,
                                String resourceName)

Minimum constructor where "cache" is set to true and "readonly" is false.

Parameters:

servletContext - the servletContext.

resourceName - the name of the file or part of the directory and name of the file, which servletContext will resolve to a file to be loaded.

See Also:

ServletContext.getRealPath(String)

Method Detail

getResourceName

public String getResourceName()

The resource file the ServletContextPropertyIO is looking for.

Returns:

the resource name

getServletContext

public javax.servlet.ServletContext getServletContext()

The servlet context that the ServletContextPropertyIO has been initialized with.

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()

Description copied from interface: PropertyIO

A detailed description of the source of the property data.

Returns:

a data source description.

getFile

protected File getFile()

The file that the servlet context has resolved the resourceName to via the ServletContext.getRealPath(String) method.

Returns:

the File that the servlet context has resolved the resource name to. Remember to check that the file exists.

See Also:

ServletContext.getRealPath(String)

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

reload

public void reload()

Description copied from interface: PropertyIO

Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time. Remember to both reset properties and typed value cache if used.

Specified by:

reload in interface PropertyIO

Overrides:

reload in class AbstractPropertyIO

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