net.sourceforge.statelessfilter.backend.session

Class SessionBackend

java.lang.Object

net.sourceforge.statelessfilter.backend.session.SessionBackend

All Implemented Interfaces:

ISessionBackend, IPlugin

public class SessionBackend
extends Object
implements ISessionBackend

Backend based on an unencrypted 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 interface net.sourceforge.statelessfilter.filter.IPlugin

TYPE_BACKEND, TYPE_REQUEST_PROCESSOR

Constructor Summary

Constructors

Constructor and Description
SessionBackend()

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) Initialize the backend using the specified configuration.
String	isBufferingRequired() Does this backend requires to buffer html.
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 java.lang.Object

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

Constructor Detail

SessionBackend

public SessionBackend()

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

See Also:

net.sourceforge.statelessfilter.backend.session.ISessionBackend#destroy()

getId

public String getId()

Description copied from interface: IPlugin

Get backend id.

Specified by:

getId in interface IPlugin

Returns:

See Also:

net.sourceforge.statelessfilter.backend.session.ISessionBackend#getId()

init

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

Description copied from interface: IPlugin

Initialize the backend using the specified configuration. Configuration can be set in /stateless.properties, using backendid.keyname=value.

Specified by:

init in interface IPlugin

Throws:

Exception

See Also:

net.sourceforge.statelessfilter.backend.session.ISessionBackend#init(java.util.Map)

isBufferingRequired

public String isBufferingRequired()

Description copied from interface: IPlugin

Does this backend requires to buffer html. Mandatory for cookie-based backends.

Specified by:

isBufferingRequired in interface IPlugin

Returns:

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

Returns:

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

See Also:

net.sourceforge.statelessfilter.backend.session.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

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:

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