Skip to main content

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

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


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

msnicklous commented on PORTLETSPEC3-9:
---------------------------------------

I propose the following changes to the javadoc descriptions of the 
createRenderURL, createActionURL, and createResourceURL methods on the 
MimeResponse class:

{panel}
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 new render URL will not contain any private render parameters from the 
current request.

The returned URL can be further extended by adding portlet-specific render 
parameters and portlet modes and window states. Any parameter added to the 
render URL is automatically a render parameter.

Public render parameters do not need to be explicitly added to the new render 
URL, unless the public render parameter value is to be changed. Any public 
render parameters associated with the portlet will automatically be available 
during render request processing resulting from activation of the URL.

If a public render parameter value is changed on a render URL, then the 
public render parameter will be set to the new value when the URL is 
activated.

Returns:
    a portlet render URL
{panel}
{panel}
PortletURL createActionURL()

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 an 
action request.

The new action URL will not contain any private render parameters from the 
current request.

The returned URL can be further extended by adding portlet-specific action 
parameters and portlet modes and window states. Any parameter added to the 
action URL is automatically an action parameter.

Public render parameters do not need to be explicitly added to the new action 
URL. Any public render parameters associated with the portlet will 
automatically be available during action request processing resulting from 
activation of the URL.

If an action parameter has the same name as a public render parameter, then 
both the action parameter value(s) and the render parameter value(s) will be 
available when the action request is triggered. The action parameter value(s) 
will appear before the render parameter value(s) in the parameter values 
array.

Returns:
    a portlet action URL
{panel}
{panel}
ResourceURL createResourceURL()

Creates a resource URL targeting the portlet. If no security modifier is set 
in the ResourceURL the current values are preserved. The current render 
parameters, portlet mode and window state are preserved depending on the 
cacheability setting for the new resource URL.

If a request is triggered by the ResourceURL, it results in a serve resource 
request of the ResourceServingPortlet interface.

If cacheability is set to PORTLET or PAGE, the values of the render 
parameters are preserved. Otherwise, the render parameters will not be 
preserved.

The public and private render parameters are added to the URL with their 
current value. The render parameter values cannot be changed on the URL.

The returned URL can be further extended by adding portlet-specific resource 
parameters. Any parameter added to the resource URL is automatically a 
resource parameter. If a resource parameter has the same name as a public or 
private render parameter, then both the resource parameter values and the 
render parameter values will be available when the resource request is 
triggered. The resource parameter value(s) will appear before the render 
parameter value(s) in the parameter values array.

The created URL will contain the current cacheability setting of the parent 
resource by default. If no parent resource is available, PAGE is the default.

Returns:
    a portlet resource URL
{panel}

> 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
>            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