org.gatein.wsrp.consumer.handlers

Class SessionHandler

java.lang.Object

org.gatein.wsrp.consumer.handlers.SessionHandler

All Implemented Interfaces:

SessionEventListener

public class SessionHandler
extends Object
implements SessionEventListener

Manages session information and operations on behalf of a consumer.

Since:

2.4 (May 31, 2006)

Version:

$Revision: 9360 $

Author:

Chris Laprun

Field Summary

Fields

Modifier and Type	Field and Description
protected WSRPConsumerImpl	consumer

Constructor Summary

Constructors

Constructor and Description
SessionHandler(WSRPConsumerImpl consumer) Constructs a new SessionHandler.

Method Summary

Methods

Modifier and Type	Method and Description
ProducerSessionInformation	getProducerSessionInformation(javax.servlet.http.HttpSession session) Retrieves the ProducerSessionInformation from the specified session.
ProducerSessionInformation	getProducerSessionInformation(org.gatein.pc.api.invocation.PortletInvocation invocation) Retrieves the ProducerSessionInformation containing the current state of what is known session-wise for this producer, creating a new one if none existed previously.
static String	getRealId(String sessionId) Returns a session id with any trailing jvmRoute removed.
void	initCookieIfNeeded(org.gatein.pc.api.invocation.PortletInvocation invocation) Invokes initCookie if needed (i.e.
boolean	isPerUserCookieInit() Whether initCookie needs to be called once per user.
void	onSessionEvent(SessionEvent event) Listen to consumer-side session destruction events to notify the producer that the portlet sessions for that user need to be released.
void	releaseSessions()
boolean	requiresInitCookie() Whether the associated producer requires initCookie to be called.
void	resetCurrentlyHeldInformation() Resets the information held by RequestHeaderClientHandler for the current interaction.
void	updateSessionIfNeeded(SessionContext sessionContext, org.gatein.pc.api.invocation.PortletInvocation invocation, String portletHandle) Updates, if needed, the known session information based on the data provided by the specified SessionContext (i.e.
void	updateSessionInfoFor(String originalHandle, String newHandle, org.gatein.pc.api.invocation.PortletInvocation invocation) Maintains session information associated with portlets when their handle is modified (for example, after a clone operation).

Methods inherited from class java.lang.Object

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

Field Detail

consumer

protected WSRPConsumerImpl consumer

Constructor Detail

SessionHandler

public SessionHandler(WSRPConsumerImpl consumer)

Constructs a new SessionHandler.

Parameters:

consumer - the consumer this SessionHandler is associated with.

Method Detail

isPerUserCookieInit

public boolean isPerUserCookieInit()

Whether initCookie needs to be called once per user.

Returns:

whether initCookie needs to be called once per user.

requiresInitCookie

public boolean requiresInitCookie()

Whether the associated producer requires initCookie to be called.

Returns:

whether the associated producer requires initCookie to be called.

resetCurrentlyHeldInformation

public void resetCurrentlyHeldInformation()

Resets the information held by RequestHeaderClientHandler for the current interaction.

initCookieIfNeeded

public void initCookieIfNeeded(org.gatein.pc.api.invocation.PortletInvocation invocation)
                        throws org.gatein.pc.api.PortletInvokerException

Invokes initCookie if needed (i.e. if not already done) on the producer for the specified PortletInvocation.

Parameters:

invocation - the current PortletInvocation potentially requiring the consumer to call initCookie on the producer

Throws:

org.gatein.pc.api.PortletInvokerException

updateSessionIfNeeded

public void updateSessionIfNeeded(SessionContext sessionContext,
                         org.gatein.pc.api.invocation.PortletInvocation invocation,
                         String portletHandle)

Updates, if needed, the known session information based on the data provided by the specified SessionContext (i.e. producer-provided data).

Parameters:

sessionContext - the WSRP SessionContext containing potential session information updates

invocation - the current PortletInvocation

portletHandle - the handle identifying the portlet being interacted with

getProducerSessionInformation

public ProducerSessionInformation getProducerSessionInformation(org.gatein.pc.api.invocation.PortletInvocation invocation)

Retrieves the ProducerSessionInformation containing the current state of what is known session-wise for this producer, creating a new one if none existed previously.

Parameters:

invocation - the current PortletInvocation (to be able to retrieve the current consumer-side HTTP session where the information is kept)

Returns:

the current ProducerSessionInformation or a new one if none existed previously

getProducerSessionInformation

public ProducerSessionInformation getProducerSessionInformation(javax.servlet.http.HttpSession session)

Retrieves the ProducerSessionInformation from the specified session.

Parameters:

session - the consumer-side session to retrieve a ProducerSessionInformation from

Returns:

the ProducerSessionInformation stored in the specified consumer-side session or null if none exists

releaseSessions

public void releaseSessions()
                     throws org.gatein.pc.api.PortletInvokerException

Throws:

org.gatein.pc.api.PortletInvokerException

Since:

2.6

onSessionEvent

public void onSessionEvent(SessionEvent event)

Listen to consumer-side session destruction events to notify the producer that the portlet sessions for that user need to be released.

Specified by:

onSessionEvent in interface SessionEventListener

Parameters:

event - any SessionEvent so we need to only process SessionEvent.SessionEventType#SESSION_DESTROYED event types

getRealId

public static String getRealId(String sessionId)

Returns a session id with any trailing jvmRoute removed. Needed for session handling code to work properly in clustered environment where the session id might contain the node identifier.

Copied from org.jboss.web.tomcat.service.session.Util.

Parameters:

sessionId - the raw session id

Returns:

sessionId with the final '.' and any characters thereafter removed.

updateSessionInfoFor

public void updateSessionInfoFor(String originalHandle,
                        String newHandle,
                        org.gatein.pc.api.invocation.PortletInvocation invocation)

Maintains session information associated with portlets when their handle is modified (for example, after a clone operation).

Parameters:

originalHandle - the original handle of the portlet

newHandle - the new portlet handle

invocation - the invocation associated with the operation

Since:

2.6