Skip to main content

[JIRA] Commented: (PORTLETSPEC3-4) Errata: Clarification for PortletRequest.getPortletSession()

  • From: "mfreedma (JIRA)" < >
  • To:
  • Subject: [JIRA] Commented: (PORTLETSPEC3-4) Errata: Clarification for PortletRequest.getPortletSession()
  • Date: Fri, 24 May 2013 16:01:59 +0000 (UTC)
  • Auto-submitted: auto-generated


    [ 
https://java.net/jira/browse/PORTLETSPEC3-4?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=364547#action_364547
 ] 

mfreedma commented on PORTLETSPEC3-4:
-------------------------------------

Looks good.

> Errata: Clarification for PortletRequest.getPortletSession()
> ------------------------------------------------------------
>
>                 Key: PORTLETSPEC3-4
>                 URL: https://java.net/jira/browse/PORTLETSPEC3-4
>             Project: portletspec3
>          Issue Type: Improvement
>          Components: JSR 286 Portlet Specification Errata
>            Reporter: msnicklous
>            Priority: Minor
>
> To be consistent with HttpServletRequest.getSession(), the Javadoc for
> PortletRequest.getPortletSession() should be changed as follows:
> Original:
> -------------------------
> PortletSession getPortletSession(boolean create)
>     Returns the current portlet session or, if there is no current session 
> and the given flag is true, creates one and returns the new session.
>     If the given flag is false and there is no current portlet session, 
> this method returns null.
>     Creating a new portlet session will result in creating a new 
> HttpSession on which the portlet session is based on.
>     Parameters:
>         create - true to create a new session,
>         false to return null if there is no current session 
>     Returns:
>         the portlet session
> -------------------------
> Corrected:
> -------------------------
> PortletSession getPortletSession(boolean create)
>     Returns the current portlet session or, if there is no current session 
> and the given flag is true, creates one and returns the new session.
>     If the given flag is false and there is no current portlet session, 
> this method returns null.
>     Creating a new portlet session will result in creating a new 
> HttpSession on which the portlet session is based.
>     To make sure the session is properly maintained, you must call this 
> method before the response is committed. 
>     If the container is using cookies to maintain session integrity and is 
> asked to create a new session when 
>     the response is committed, an IllegalStateException is thrown.        
>     
>     Parameters:
>         create - true to create a new session,
>         false to return null if there is no current session 
>     Returns:
>         the portlet session

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
https://java.net/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        


[JIRA] Commented: (PORTLETSPEC3-4) Errata: Clarification for PortletRequest.getPortletSession()

mfreedma (JIRA) 05/24/2013
 
 
Close
loading
Please Confirm
Close