dk.heick.properties.io.http

Class HttpCookiesPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.http.AbstractHttpPropertyIO

dk.heick.properties.io.http.HttpCookiesPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class HttpCookiesPropertyIO
extends AbstractHttpPropertyIO

Handle Cookie objects from the HttpServletRequest.
Can read and write cookies.
When writing a value to a cookie, it will be written to the HttpServletResponse.addCookie(...).

Since:

1.6

Author:

Frederik Heick

See Also:

Serialized Form

Field Summary

Fields inherited from class dk.heick.properties.io.http.AbstractHttpPropertyIO

DEFAULT_PARAMETER_VALUES_DIVIDER

Constructor Summary

Constructors

Constructor and Description
HttpCookiesPropertyIO(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) Constructor.
HttpCookiesPropertyIO(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, boolean readonly)

Method Summary

Modifier and Type	Method and Description
javax.servlet.http.Cookie	getCookie(Property<?> property) Gets a Cookie by its Property .
javax.servlet.http.Cookie	getCookie(String propertyName) Gets a Cookie by its Property name.
javax.servlet.http.Cookie	getCookieForUpdate(Property<?> property) Gets a Cookie by its name and adds it to the HttpServletResponse if found.
javax.servlet.http.Cookie	getCookieForUpdate(String propertyName) Gets a Cookie by its name and adds it to the HttpServletResponse if found.
javax.servlet.http.HttpServletResponse	getHttpServletResponse() The HttpServletResponse which was provided in the constructor.
String	getName() A short descriptive name of the Property IO.
Properties	getProperties() Gets all the name,value pair in a Properties class instance.
void	setValue(String propertyName, String value) Sets the name,value as String in the IO.
void	validate() Validates the IO.

Methods inherited from class dk.heick.properties.io.http.AbstractHttpPropertyIO

addHttpRequestHeadersProperties, addHttpRequestParamsProperties, getHttpServletRequest, getParameterValuesDivider, getSource

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

HttpCookiesPropertyIO

public HttpCookiesPropertyIO(javax.servlet.http.HttpServletRequest httpServletRequest,
                             javax.servlet.http.HttpServletResponse httpServletResponse)

Constructor.

Parameters:

httpServletRequest - the HttpServletRequest context to get the cookies.

httpServletResponse - the HttpServletResponse where to add new cookies if they are not defined.

HttpCookiesPropertyIO

public HttpCookiesPropertyIO(javax.servlet.http.HttpServletRequest httpServletRequest,
                             javax.servlet.http.HttpServletResponse httpServletResponse,
                             boolean readonly)

Method Detail

getHttpServletResponse

public javax.servlet.http.HttpServletResponse getHttpServletResponse()

The HttpServletResponse which was provided in the constructor.

Returns:

The HttpServletResponse.

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.

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 class: AbstractHttpPropertyIO

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.

Specified by:

validate in interface PropertyIO

Overrides:

validate in class AbstractHttpPropertyIO

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

getCookie

public final javax.servlet.http.Cookie getCookie(String propertyName)

Gets a Cookie by its Property name.

Parameters:

propertyName - the name of Cookie.

Returns:

the Cookie if found otherwise null is returned.

getCookie

public final javax.servlet.http.Cookie getCookie(Property<?> property)

Gets a Cookie by its Property .

Parameters:

property - the property

Returns:

the Cookie if found otherwise null is returned.

getCookieForUpdate

public final javax.servlet.http.Cookie getCookieForUpdate(String propertyName)

Gets a Cookie by its name and adds it to the HttpServletResponse if found.

Parameters:

propertyName - the name of Cookie.

Returns:

the Cookie if found otherwise null is returned.

getCookieForUpdate

public final javax.servlet.http.Cookie getCookieForUpdate(Property<?> property)

Gets a Cookie by its name and adds it to the HttpServletResponse if found.

Parameters:

property - the property

Returns:

the Cookie if found otherwise null is returned.