Skip to main content

[JIRA] Created: (PORTLETSPEC3-35) Errata: apidoc description of MimeResponse.setContentType() needs to specify exception

  • From: "msnicklous (JIRA)" < >
  • To:
  • Subject: [JIRA] Created: (PORTLETSPEC3-35) Errata: apidoc description of MimeResponse.setContentType() needs to specify exception
  • Date: Wed, 21 Aug 2013 11:40:19 +0000 (UTC)
  • Auto-submitted: auto-generated

Errata: apidoc description of MimeResponse.setContentType() needs to specify 
exception
--------------------------------------------------------------------------------------

                 Key: PORTLETSPEC3-35
                 URL: https://java.net/jira/browse/PORTLETSPEC3-35
             Project: portletspec3
          Issue Type: Improvement
          Components: JSR 286 Portlet Specification Errata
            Reporter: msnicklous
            Assignee: msnicklous
            Priority: Minor


The portlet specification in section 12.5.1 Content Type states:

bq. For the render response the setContentType method must throw an 
IllegalArgumentException if the content type set does not match (including 
wildcard matching) any of the content types returned by the 
getResponseContentType method of the PortletRequest objectcxii.

However, this is not reflected in the apidocs for the method.

{panel}
void setContentType(String type)

Sets the MIME type for the response. The portlet should set the content type 
before calling getWriter() or getPortletOutputStream(). If the content type 
is not the PortletRequest.getResponseContentType() value is set as response 
content type by the portlet container.

Calling setContentType after getWriter or getOutputStream does not change the 
content type.

Parameters:
    type - the content MIME type
See Also:
    PortletRequest.getResponseContentTypes(), getContentType()
{panel}

We need to add a "Throws" section to the description. I would also use the 
opportunity to fix the description ... seems to be worded strangely. I 
believe the following captures the intention:

{panel}
void setContentType(String type)

Sets the MIME type for the response. The portlet should set the content type 
before calling getWriter() or getPortletOutputStream(). If the content type 
is not set using this method, the preferred content type as returned by 
PortletRequest.getResponseContentType() is used.

Calling setContentType after getWriter or getOutputStream does not change the 
content type.

Parameters:
    type - the content MIME type
See Also:
    PortletRequest.getResponseContentTypes(), getContentType()
Throws:
    IllegalArgumentException - if the content type is invalid.
{panel}

-- 
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] Created: (PORTLETSPEC3-35) Errata: apidoc description of MimeResponse.setContentType() needs to specify exception

msnicklous (JIRA) 08/21/2013

[JIRA] Resolved: (PORTLETSPEC3-35) Errata: apidoc description of MimeResponse.setContentType() needs to specify exception

msnicklous (JIRA) 08/22/2013
 
 
Close
loading
Please Confirm
Close