Skip to main content

[JIRA] Commented: (PORTLETSPEC3-9) Errata: Clarification needed for method MimeResponse.createRenderURL

  • From: "Neil Griffin (JIRA)" < >
  • To:
  • Subject: [JIRA] Commented: (PORTLETSPEC3-9) Errata: Clarification needed for method MimeResponse.createRenderURL
  • Date: Tue, 30 Jul 2013 14:00:24 +0000 (UTC)
  • Auto-submitted: auto-generated


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

Neil Griffin commented on PORTLETSPEC3-9:
-----------------------------------------

Recommend using either "The new" or "The returned" in a consistent manner. 
Currently both terms are used very close together, though they refer to the 
same thing.

Also, the general term "render parameter" is meaningful when it refers to 
either Public/Private Render Parameters that the portlet developer has 
explicitly set via StateAwareResponse.setRenderParameter(String name, String 
value). These are parameters that are set in the ACTION_PHASE/EVENT_PHASE and 
intended to survive into the RENDER_PHASE.

However I think that the general term "render parameters" becomes 
vague/ambiguous when referring to parameters set on a URL. While it is true 
that a Public Render Parameter can be set on a URL, I don't think we can 
precisely say Private Render Parameters can be set on a URL. Rather, they are 
simply Private Parameters (not Private _Render_ Parameters) when set on a URL.

Because of this, I would recommend that the following sentence be clarified 
or perhaps not added:

{quote}Any parameter added to the render URL is automatically a render 
parameter.{quote}


> Errata: Clarification needed for method MimeResponse.createRenderURL
> --------------------------------------------------------------------
>
>                 Key: PORTLETSPEC3-9
>                 URL: https://java.net/jira/browse/PORTLETSPEC3-9
>             Project: portletspec3
>          Issue Type: Improvement
>          Components: JSR 286 Portlet Specification Errata
>            Reporter: msnicklous
>            Assignee: msnicklous
>            Priority: Minor
>
> The description contains a statement that I believe to be incorrect. It 
> states:
> "The created URL will per default not contain any parameters of the current 
> render request."
> However, the created URL I believe must contain any public render 
> parameters that were set on
> the request. Also, the term "current render request" may be misleading. 
> What is meant is the 
> request that is being executed  when the URL is created.
> So I would propose the following update:
> Original:
> -------------------------
> createRenderURL
> PortletURL createRenderURL()
>     Creates a portlet URL targeting the portlet. If no portlet mode, window 
> state or security modifier is set in the PortletURL the current values are 
> preserved. If a request is triggered by the PortletURL, it results in a 
> render request.
>     The returned URL can be further extended by adding portlet-specific 
> parameters and portlet modes and window states.
>     The created URL will per default not contain any parameters of the 
> current render request.
>     Returns:
>         a portlet render URL
> -------------------------
> Corrected:
> -------------------------
> createRenderURL
> PortletURL createRenderURL()
>     Creates a portlet URL targeting the portlet. If no portlet mode, window 
> state or security modifier is set in the PortletURL the current values are 
> preserved. If a request is triggered by the PortletURL, it results in a 
> render request.
>     The returned URL can be further extended by adding portlet-specific 
> parameters and portlet modes and window states.
>     The created URL will per default contain only the public render 
> parameters from the request 
>     being executed when the render URL is created.
>     Returns:
>         a portlet render URL
> -------------------------
> The same change should be made for the MimeResponse.createActionURL method.

-- 
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-9) Errata: Clarification needed for method MimeResponse.createRenderURL

msnicklous (JIRA) 07/30/2013

<Possible follow-up(s)>

[JIRA] Commented: (PORTLETSPEC3-9) Errata: Clarification needed for method MimeResponse.createRenderURL

Neil Griffin (JIRA) 07/30/2013

[JIRA] Commented: (PORTLETSPEC3-9) Errata: Clarification needed for method MimeResponse.createRenderURL

msnicklous (JIRA) 07/30/2013
 
 
Close
loading
Please Confirm
Close