Interface HeaderPortlet

  • All Known Implementing Classes:
    GenericPortlet

    public interface HeaderPortlet
    The HeaderPortlet interface provides portlets with the ability to add HTTP headers to the response, and to generate markup for aggregation into the portal response document head section.

    Since:
    3.0
    See Also:
    HeaderRequest, HeaderResponse
    • Method Detail

      • renderHeaders

        void renderHeaders​(HeaderRequest request,
                           HeaderResponse response)
                    throws PortletException,
                           IOException
        Called by the portlet container to allow the portlet to set response headers and generate markup for overall response document head section.
        Parameters:
        request - the header request
        response - the header response
        Throws:
        PortletException - if the portlet has problems fulfilling the request
        UnavailableException - if the portlet is unavailable to process the request at this time
        PortletSecurityException - if the portlet cannot fulfill this request due to security reasons
        IOException - if the streaming causes an I/O problem