com.amadeus.session.servlet

Class SessionHelpers

java.lang.Object

com.amadeus.session.servlet.SessionHelpers

public final class SessionHelpers
extends Object

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

Constructor Summary

Constructors

Constructor and Description
SessionHelpers()

Method Summary

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

Constructor Detail

SessionHelpers

public SessionHelpers()

Method Detail

prepareRequest

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

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

originalServletContext - ServletContext used when filter was initialized

Returns:

wrapped or original request

prepareResponse

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

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

Returns:

wrapped or original response

initSessionManagement

public MethodHandle[] initSessionManagement(javax.servlet.ServletContext servletContext)

This method initializes session management for a given ServletContext. This method is called from SessionFilter.init(javax.servlet.FilterConfig). The method will create and configure SessionManager if needed.

Parameters:

servletContext - the active servlet context

Returns:

list of method handles for publicly accessible methods

commitRequest

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

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

interceptHttpListener

public void interceptHttpListener(EventListener caller,
                                  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:

caller - listener where event was received

event - event that was received

onAddListener

public void onAddListener(javax.servlet.ServletContext servletContext,
                          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:

servletContext - the active servlet context

listener - the listener to use