net.sourceforge.statelessfilter.backend.plaincookie

Class PlainCookieBackend

java.lang.Object

net.sourceforge.statelessfilter.backend.support.CookieBackendSupport

net.sourceforge.statelessfilter.backend.plaincookie.PlainCookieBackend

All Implemented Interfaces:

ISessionBackend, IPlugin

public class PlainCookieBackend
extends CookieBackendSupport

Backend based on an uncrypted cookie. Can be used for non sensitive data. Cookie can be compressed to save bandwidth.

Parameters :

• cookiename : name of the cookie
• compress : enable cookie compression (gzip) when value is "true"

Author:

Nicolas Richeton - Capgemini

Field Summary

Fields inherited from class net.sourceforge.statelessfilter.backend.support.CookieBackendSupport

cookieName, domain, maxAge, PARAM_COOKIEDOMAIN, PARAM_COOKIEMAXAGE, PARAM_COOKIENAME, PARAM_COOKIEPATH, path

Fields inherited from interface net.sourceforge.statelessfilter.filter.IPlugin

TYPE_BACKEND, TYPE_REQUEST_PROCESSOR

Constructor Summary

Constructors

Constructor and Description
PlainCookieBackend()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroy the backend.
String	getId() Get backend id.
void	init(Map<String,String> config) Read cookie configuration : name, path, domain and maxAge.
ISessionData	restore(javax.servlet.http.HttpServletRequest request) Restores a session from the backend.
void	save(ISessionData session, List<String> dirtyAttributes, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Saves a session to the backend.

Methods inherited from class net.sourceforge.statelessfilter.backend.support.CookieBackendSupport

getCookieData, getCookieData, getFullRemoteAddr, isBufferingRequired, setCookieData, setCookieData, setCookieName

Methods inherited from class java.lang.Object

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

Constructor Detail

PlainCookieBackend

public PlainCookieBackend()

Method Detail

destroy

public void destroy()

Description copied from interface: IPlugin

Destroy the backend. Used to perform some cleanup if necessary.

Specified by:

destroy in interface IPlugin

Specified by:

destroy in class CookieBackendSupport

See Also:

com.capgemini.stateless.backend.plaincookie.ISessionBackend#destroy()

getId

public String getId()

Description copied from interface: IPlugin

Get backend id.

Specified by:

getId in interface IPlugin

Specified by:

getId in class CookieBackendSupport

Returns:

See Also:

com.capgemini.stateless.backend.plaincookie.ISessionBackend#getId()

init

public void init(Map<String,String> config)
          throws Exception

Description copied from class: CookieBackendSupport

Read cookie configuration : name, path, domain and maxAge.

Specified by:

init in interface IPlugin

Overrides:

init in class CookieBackendSupport

Throws:

Exception

See Also:

com.capgemini.stateless.backend.plaincookie.ISessionBackend#init(java.util.Map)

restore

public ISessionData restore(javax.servlet.http.HttpServletRequest request)

Description copied from interface: ISessionBackend

Restores a session from the backend.

Specified by:

restore in interface ISessionBackend

Specified by:

restore in class CookieBackendSupport

Returns:

session data or null if session does not exists or restoration failed.

See Also:

com.capgemini.stateless.backend.plaincookie.ISessionBackend#restore(javax.servlet.http.HttpServletRequest)

save

public void save(ISessionData session,
        List<String> dirtyAttributes,
        javax.servlet.http.HttpServletRequest request,
        javax.servlet.http.HttpServletResponse response)
          throws IOException

Description copied from interface: ISessionBackend

Saves a session to the backend.

Specified by:

save in interface ISessionBackend

Specified by:

save in class CookieBackendSupport

Parameters:

session - Current session.

dirtyAttributes - list of attributes that were added/changed/removed during the current request.

request - Current request.

response - Current response.

Throws:

IOException

See Also:

CookieBackendSupport.save(net.sourceforge.statelessfilter.backend.ISessionData, java.util.List, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)