org.gatein.wsrp.consumer.handlers

Class ProducerSessionInformation

java.lang.Object

org.gatein.wsrp.consumer.handlers.ProducerSessionInformation

All Implemented Interfaces:

Serializable

public class ProducerSessionInformation
extends Object
implements Serializable

Records portlet session and cookie information for a given producer. Per the WSRP spec, cookies can be initialized by the producer and should then be returned on each invocation by the consumer. This initialization can happen once per user or once per portlet group so we need to track this information whether cookies have been initialized for a given portlet group / user. See the WSRP CookieProtocol specification for more details.

We also need to track portlet sessions for each portlet and potential user-level cookies (which the remote producer might use independently of WSRP).

Unless otherwise specified, public method that return cookies and their various representations, do so after having purged any expired cookies.

Since:

2.4 (May 30, 2006)

Version:

$Revision: 12736 $

Author:

Chris Laprun

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProducerSessionInformation()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSessionForPortlet(String portletHandle, SessionContext sessionContext) Associates the portlet session information provided by the specified SessionContext with the portlet identified by the specified portlet handle.
List<String>	getGroupCookiesFor(String groupId) Retrieves the String representations of the cookies associated with the portlet group identified by the specified group identifier.
String	getSessionIdForPortlet(String portletHandle) Retrieves the session id for the portlet with the specified handle.
List<String>	getUserCookies() Retrieves an up-to-date list of String representations of user-level cookies.
boolean	isInitCookieDone() Whether we already called initCookie for the associated producer.
boolean	isPerGroupCookies() Whether the producer required cookies to be initialized per portlet group instead of per user.
void	setGroupCookiesFor(String groupId, List<CookieUtil.Cookie> cookies) Associates the given cookies with a given portlet group, as identified by the specified group identifier.
void	setPerGroupCookies(boolean perGroupCookies) Only public for test purposes.
void	setUserCookies(List<CookieUtil.Cookie> userCookie)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProducerSessionInformation

public ProducerSessionInformation()

Method Detail

getUserCookies

public List<String> getUserCookies()

Retrieves an up-to-date list of String representations of user-level cookies.

Returns:

an up-to-date list of String representations of user-level cookies.

setUserCookies

public void setUserCookies(List<CookieUtil.Cookie> userCookie)

isInitCookieDone

public boolean isInitCookieDone()

Whether we already called initCookie for the associated producer.

Returns:

true if initCookie has already been called, false otherwise

isPerGroupCookies

public boolean isPerGroupCookies()

Whether the producer required cookies to be initialized per portlet group instead of per user.

Returns:

true if the producer required cookies to be initialized per portlet group, false otherwise

setPerGroupCookies

public void setPerGroupCookies(boolean perGroupCookies)

Only public for test purposes.

Parameters:

perGroupCookies -

setGroupCookiesFor

public void setGroupCookiesFor(String groupId,
                      List<CookieUtil.Cookie> cookies)

Associates the given cookies with a given portlet group, as identified by the specified group identifier.

Parameters:

groupId - the portlet group identifier

cookies - the cookies to be associated with the portlet group

getGroupCookiesFor

public List<String> getGroupCookiesFor(String groupId)

Retrieves the String representations of the cookies associated with the portlet group identified by the specified group identifier.

Parameters:

groupId - the group identifier for which we want to retrieve the associated cookies

Returns:

the String representations of the cookies associated with the specified portlet group

addSessionForPortlet

public void addSessionForPortlet(String portletHandle,
                        SessionContext sessionContext)

Associates the portlet session information provided by the specified SessionContext with the portlet identified by the specified portlet handle.

Parameters:

portletHandle - the handle of the portlet with which session information needs to be associated

sessionContext - the new session information to be associated to the portlet

getSessionIdForPortlet

public String getSessionIdForPortlet(String portletHandle)

Retrieves the session id for the portlet with the specified handle. Note that this will "touch" the session, hence resetting the time since the last use of the session.

Parameters:

portletHandle - the handle of the portlet for which the session id is to be retrieved

Returns:

the session id for the specified portlet, null if there is no session associated with the portlet or if the session has expired.