net.sourceforge.statelessfilter.backend.aescookie

Class AESCookieBackend

java.lang.Object

net.sourceforge.statelessfilter.backend.support.CookieBackendSupport

net.sourceforge.statelessfilter.backend.aescookie.AESCookieBackend

All Implemented Interfaces:

ISessionBackend, IPlugin

public class AESCookieBackend
extends CookieBackendSupport

Backend based on an AES-encrypted cookie. Cookie can be compressed to save bandwidth.

Parameters :

• cookiename : name of the cookie
• compress : enable cookie compression (gzip) when value is "true"
• key : key used to encrypt data
• iv : iv used to encrypt data

Author:

Nicolas Richeton - Capgemini

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_COMPRESS
static String	PARAM_IV
static String	PARAM_KEY
static String	PARAM_RESTRICT_IP
static String	PARAM_SESSION_MAX_TIME
static String	PARAM_SIGN_SECRET

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

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroy the backend.
boolean	getCompress()
String	getId() Get backend id.
boolean	getRestrictIp()
Integer	getSessionMaxTime()
String	getSignSecret()
void	init(Map<String,String> config) Loads key and iv for encryption and performs normal init.
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

Field Detail

PARAM_COMPRESS

public static final String PARAM_COMPRESS

See Also:

Constant Field Values

PARAM_IV

public static final String PARAM_IV

See Also:

Constant Field Values

PARAM_KEY

public static final String PARAM_KEY

See Also:

Constant Field Values

PARAM_RESTRICT_IP

public static final String PARAM_RESTRICT_IP

See Also:

Constant Field Values

PARAM_SESSION_MAX_TIME

public static final String PARAM_SESSION_MAX_TIME

See Also:

Constant Field Values

PARAM_SIGN_SECRET

public static final String PARAM_SIGN_SECRET

See Also:

Constant Field Values

Constructor Detail

AESCookieBackend

public AESCookieBackend()

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

getCompress

public boolean getCompress()

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

getRestrictIp

public boolean getRestrictIp()

getSessionMaxTime

public Integer getSessionMaxTime()

getSignSecret

public String getSignSecret()

init

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

Loads key and iv for encryption and performs normal init.

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)