Access the portlet session on the anonymous page

 

+

Search Tips   |   Advanced Search

 

You can place portlets on pages presented to anonymous users (similar to the Welcome page). By default, when a portlet is placed on a page that does not require authentication and no user is logged in, the portal server track sessions across subsequent request to the server. Portlets should not create a session using the request.getSession(true) call in this case; this will result in WAS warning messages similar to:

SESN0066E: Response is already commited to client. Session cookie cannot be set.

In this case, a temporary session is created and your session information will be lost in the next request.

To enable session tracking across requests for non-authenticated users, set the public.session parameter in the NavigatorService configuration or set com.ibm.portal.public.session in a JSR 286 portlet deployment descriptor.

Note that this may result in significantly increased memory consumption. Instead of using these options, portlets that need to maintain interaction state even for non-authenticated users should use render parameters to keep this information instead of the portlet session, as recommended by the Java Portlet Specification.

All calls to request.getPortletSession() should pass in the boolean create parameter set to false. This ensures that if the user is not logged in, then an invalid PortletSession is not created and the variable session will be null. The rest of the code can then perform checks to make sure that session is not null before trying to use the PortletSession object.

The portlet may need to present the user with an appropriate message if it requires a valid PortletSession to operate correctly. For example:

This content cannot be displayed until you log in. Please report this problem to the site administrator.

In addition, the administrator will need more helpful information that the portlet can provide in the portlet log:

Unable to locate the portlet session. This portlet requires a session to function. Move the portlet to an authenticated page or turn on session tracking for anonymous users.

If the portlet does not require a session for critical operation, then perhaps any subfunctions within the portlet require the session can be suppressed to anonymous users. This should be evaluated for each individual portlet.

If request.getPortletSession() or request.getPortletSession(true) are called when the user is not logged in and WebSphere Portal is not configured to use a session for anonymous users, each request from each client creates an extraneous PortletSession object that is lost and consumes JVM memory. This causes more frequent JVM garbage collection and hurts overall WebSphere Portal performance.

In order for a portlet to function without a portlet session, add this line to the top of all portlet JSPs.

<%@ page session="false" %>

Without this directive, the JSP page compiler generates code that accesses the session even if you don't use it in your JSP. You also cannot access any beans with scope set to session in any of your JSP pages as shown.

<jsp:useBean ... scope="session" />

This will create sessions when you do not want them. Instead, determine whether the session exists, for example: 

<%
   com.ibm.MyClassName theBeanId = null;
   PortletSession session = request.getPortletSession(false);

   if (session != null) 
   {
      theBeanId = (com.ibm.MyClassName)session.getAttribute("theBeanId");
   }

   // later in your code always check to see if the bean exists before using it
   if (theBeanId != null) 
   {
      // use the bean
   }
%>

 

Related information

 

Parent topic

Portlet development reference