dk.heick.properties.io.http

Class AbstractHttpPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.http.AbstractHttpPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

Direct Known Subclasses:

HttpCookiesPropertyIO, HttpRequestHeadersPropertyIO, HttpRequestParamsPropertyIO, HttpRequestPropertyIO, HttpResponseHeadersPropertyIO

public abstract class AbstractHttpPropertyIO
extends AbstractPropertyIO

Abstract class for handling properties via HttpServletRequest.
If a parameter has multiple values, they are concatinated to one string with this as string divider, so an Property of MarkerListPropertyType can handle them.

Since:

1.8

Author:

Frederik Heick

See Also:

ServletRequest.getParameterNames(), ServletRequest.getParameterValues(String), MarkerListPropertyType, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PARAMETER_VALUES_DIVIDER If a parameter has multiple values, they are concatinated to one string with this as default divider ","

Constructor Summary

Constructors

Constructor and Description
AbstractHttpPropertyIO(javax.servlet.http.HttpServletRequest httpServletRequest, String parameterValuesDivider, boolean readonly, boolean cached) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addHttpRequestHeadersProperties(Properties l_properties) Finds all headers in the HttpServletRequest, and adds them to the properties.
protected void	addHttpRequestParamsProperties(Properties l_properties) Finds all parameters in the HttpServletRequest, and adds them to the properties.
javax.servlet.http.HttpServletRequest	getHttpServletRequest() The HttpServletRequest which was provided in the constructor.
String	getParameterValuesDivider() Get divider between multiple values for one parameter.
String	getSource() Returns remote address and session id.
void	validate() Validates the IO.

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

Methods inherited from interface dk.heick.properties.PropertyIO

getName, getProperties, setValue

Field Detail

DEFAULT_PARAMETER_VALUES_DIVIDER

public static final String DEFAULT_PARAMETER_VALUES_DIVIDER

If a parameter has multiple values, they are concatinated to one string with this as default divider ","

See Also:

Constant Field Values

Constructor Detail

AbstractHttpPropertyIO

public AbstractHttpPropertyIO(javax.servlet.http.HttpServletRequest httpServletRequest,
                              String parameterValuesDivider,
                              boolean readonly,
                              boolean cached)

Constructor

Parameters:

httpServletRequest - the request.

parameterValuesDivider - the string divider, if a named property has multiple values, they concatinated to one string with this as divider.

readonly - is the IO readonly.

cached - is the IO cached shall the values be cached in the PropertyIO's.

Method Detail

getParameterValuesDivider

public final String getParameterValuesDivider()

Get divider between multiple values for one parameter.

Returns:

the value divider for a parameter with multiple values.

getHttpServletRequest

public final javax.servlet.http.HttpServletRequest getHttpServletRequest()

The HttpServletRequest which was provided in the constructor.

Returns:

The HttpServletRequest.

getSource

public String getSource()

Returns remote address and session id. In the form "

getHttpServletRequest().getRemoteAddr()+" for session "+(session==null ? "[No session]" : session.getId());

"

Returns:

a data source description.

See Also:

ServletRequest.getRemoteAddr(), HttpSession.getId()

addHttpRequestParamsProperties

protected final void addHttpRequestParamsProperties(Properties l_properties)

Finds all parameters in the HttpServletRequest, and adds them to the properties.
Multi values parameters is concatinated using ParameterValuesDivider.

Parameters:

l_properties - the properties to add them to.

See Also:

getParameterValuesDivider()

addHttpRequestHeadersProperties

protected final void addHttpRequestHeadersProperties(Properties l_properties)

Finds all headers in the HttpServletRequest, and adds them to the properties.
Multi values headers is concatinated using ParameterValuesDivider.

Parameters:

l_properties - the properties to add them to.

See Also:

getParameterValuesDivider()

validate

public void validate()
              throws PropertyIOException

Validates the IO.

• HttpServletRequest must not be null.
• ParameterValuesDivider must not be null.
• ParameterValuesDivider must not empty after trim.
• The getProperties() must not return null.

Throws:

PropertyIOException