com.amadeus.session.servlet

Class SessionHelpersFacade

java.lang.Object

com.amadeus.session.servlet.SessionHelpersFacade

public final class SessionHelpersFacade
extends Object

This class contains various methods that are called either from session enabled filters, or from code injected by SessionAgent.

Method Summary

Modifier and Type	Method and Description
static void	commitRequest(javax.servlet.ServletRequest request, javax.servlet.ServletRequest oldRequest, javax.servlet.ServletContext filterContext) Commits request and stores session in repository.
static void	initSessionManagement(javax.servlet.ServletContext servletContext) This method initializes session management for a given ServletContext.
static void	interceptHttpListener(Object listener, javax.servlet.http.HttpSessionEvent event) Call to this method is injected by agent into implementations of HttpSessionAttributeListener and HttpSessionListener inside Servlet 2.5 containers.
static void	onAddListener(Object object, Object listener) This method is used by injected code to register listeners for ServletContext.
static javax.servlet.ServletRequest	prepareRequest(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.ServletContext filterContext) This method is called from SessionFilter or from Filter implementations modified by SessionAgent.
static javax.servlet.ServletResponse	prepareResponse(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.ServletContext filterContext) This method is called from SessionFilter or from Filter implementations modified by SessionAgent.

Methods inherited from class java.lang.Object

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

Method Detail

prepareRequest

public static javax.servlet.ServletRequest prepareRequest(javax.servlet.ServletRequest request,
                                                          javax.servlet.ServletResponse response,
                                                          javax.servlet.ServletContext filterContext)

This method is called from SessionFilter or from Filter implementations modified by SessionAgent. The method wraps ServletRequest in HttpRequestWrapper.

The method will wrap request at most once per request and will only wrap instances of HttpServletRequest.

Parameters:

request - request received by filter

response - response received by filter

filterContext - ServletContext used when filter was initialized

Returns:

wrapped or original request

prepareResponse

public static javax.servlet.ServletResponse prepareResponse(javax.servlet.ServletRequest request,
                                                            javax.servlet.ServletResponse response,
                                                            javax.servlet.ServletContext filterContext)

This method is called from SessionFilter or from Filter implementations modified by SessionAgent. The method retrieves response stored in HttpRequestWrapper.

Parameters:

request - request received by filter

response - response received by filter

filterContext - servlet context of the filter

Returns:

wrapped or original response

initSessionManagement

public static void initSessionManagement(javax.servlet.ServletContext servletContext)

This method initializes session management for a given ServletContext. This method is called from SessionFilter.init(javax.servlet.FilterConfig).

Parameters:

servletContext - the servlet context where filter is registered

commitRequest

public static void commitRequest(javax.servlet.ServletRequest request,
                                 javax.servlet.ServletRequest oldRequest,
                                 javax.servlet.ServletContext filterContext)

Commits request and stores session in repository. This method is called from the filter. The commit is only done if the filter is the one that wrapped the request into HttpRequestWrapper.

The logic to check if the caller filter is the one that wrapped request is based on requirement that original request and the one used by filter are different and that original request is not HttpRequestWrapper.

Parameters:

request - potentially wrapped request

oldRequest - original request received by filter

filterContext - servlet context of the filter

interceptHttpListener

public static void interceptHttpListener(Object listener,
                                         javax.servlet.http.HttpSessionEvent event)

Call to this method is injected by agent into implementations of HttpSessionAttributeListener and HttpSessionListener inside Servlet 2.5 containers. It's roll is to collect session listeners so they can be invoked by the library when it manages sessions.

Parameters:

listener - listener where event was received

event - event that was received

onAddListener

public static void onAddListener(Object object,
                                 Object listener)

This method is used by injected code to register listeners for ServletContext. If object argument is a ServletContext and listener argument contains HttpSessionListener or HttpSessionAttributeListener, the method will add them to list of known listeners associated to ServletContext

Parameters:

object - the object that should be servlet context

listener - the listener object