portletspec3
  1. portletspec3
  2. PORTLETSPEC3-10

Errata: Clarify setting parameters on Resource URLs

    Details

      Description

      Referring to Working Document 3 (22.04.13) Section "PLT.7.1.1 BaseURL Interface",
      lines 14-16 on page 55, it is stated:

      -------------------------
      When creating a ResourceURL the current render parameters are
      automatically added to that URL by the portlet container, but are hidden to the
      getParameter calls of the portlet URL object.
      -------------------------

      My assumption would be that since the render parameters are hidden, they cannot be
      removed. Would this be correct? Can existing render parameters on resource URLs be set?

      Section "PLT.11.1.1.4 Resource Request Parameters", page 75, line 29 states the following,
      so it appears that at minimum, new render parameters may be added to Resource URLs.

      -------------------------
      For serveResource requests the portlet must receive any resource parameters that
      were explicitly set on the ResourceURL that triggered the request.
      -------------------------

      Since ResourceURL extends BaseURL, and since BaseURL defines get / set parameter
      methods, we may need addition clarification in the description of the BaseURL class.

        Activity

        Hide
        Neil Griffin added a comment - - edited

        My assumption would be that since the render parameters are hidden, they cannot be removed. Would this be correct?

        The following causes an IllegalStateException on Pluto, even though the JavaDoc for BaseURL.setParameter(String, String) indicates that the URL parameter should be removed when null is passed:

        ResourceURL.setParameter("publicRenderParam", (String) null);
        

        Can existing render parameters on resource URLs be set?

        The following is a no-op on Pluto during the RENDER_PHASE (meaning that the existing value of the Public Render Parameter is preserved in the string representation of the resource URL, instead of the overridden value of "abcd"):

        ResourceURL.setParameter("publicRenderParam", "abcd");
        

        But in the RESOURCE_PHASE, it works, meaning the string representation of the resource URL contains the overridden value of "abcd".

        Show
        Neil Griffin added a comment - - edited My assumption would be that since the render parameters are hidden, they cannot be removed. Would this be correct? The following causes an IllegalStateException on Pluto, even though the JavaDoc for BaseURL.setParameter(String, String) indicates that the URL parameter should be removed when null is passed: ResourceURL.setParameter( "publicRenderParam" , ( String ) null ); Can existing render parameters on resource URLs be set? The following is a no-op on Pluto during the RENDER_PHASE (meaning that the existing value of the Public Render Parameter is preserved in the string representation of the resource URL, instead of the overridden value of "abcd"): ResourceURL.setParameter( "publicRenderParam" , "abcd" ); But in the RESOURCE_PHASE, it works, meaning the string representation of the resource URL contains the overridden value of "abcd".
        Show
        Neil Griffin added a comment - Test Portlet: https://github.com/ngriffin7a/portletbox/tree/master/issues/PORTLETSPEC3-10-portlet
        Hide
        msnicklous added a comment -

        reworked apidocs to clarify how parameters are set.

        Show
        msnicklous added a comment - reworked apidocs to clarify how parameters are set.
        Hide
        msnicklous added a comment -

        reviewed on 20130730 and can be closed.

        Show
        msnicklous added a comment - reviewed on 20130730 and can be closed.

          People

          • Assignee:
            Unassigned
            Reporter:
            msnicklous
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: