Class ResponseProperties


  • public class ResponseProperties
    extends Object
    ResponseProperties holds the properties set by the Portlet. These properties include cookies and headers that are set on the Response. It also includes DOM element should be added to the markup head section of the response to the client.
    • Constructor Detail

      • ResponseProperties

        public ResponseProperties()
    • Method Detail

      • getResponseHeaders

        public Map<String,​List<String>> getResponseHeaders()
        Returns the Map of response headers that are set are by the portlet using addProperty method of PortletResponse. If there is no response headers, returns an empty map.
        Returns:
        the Map of the response headers that set by the portlet
      • getMarkupHeadElements

        public List<Element> getMarkupHeadElements()
        Returns the list of DOM Elements that are set by the portlet using addProperty method of PortletResponse with the property name as "javax.portlet.markup.head.element". If there is no DOM elements, it returns an empty list.
        Returns:
        the list of the DOM Elements that set by the portlet
      • getCookies

        public List<javax.servlet.http.Cookie> getCookies()
        Returns the list of Cookies that are set by the portlet using addProperty method of PortletResponse. If there is no cookies, it returns an empty list.
        Returns:
        the list of the DOM Elements that set by the portlet
      • setResponseHeaders

        public void setResponseHeaders​(Map<String,​List<String>> responseHeaders)
        Sets the response headers.
        Parameters:
        responseHeaders - the response headers
      • setMarkupHeaders

        public void setMarkupHeaders​(Map<String,​List<Element>> markupHeaders)
        Sets the markup headers.
        Parameters:
        markupHeaders - the markup headers
      • setCookies

        public void setCookies​(List<javax.servlet.http.Cookie> cookies)
        Sets the cookies.
        Parameters:
        cookies - the cookies
      • clear

        public void clear()
        Clears the response properties