Class ResourceRequestWrapper

  • All Implemented Interfaces:
    ClientDataRequest, PortletRequest, ResourceRequest

    public class ResourceRequestWrapper
    extends PortletRequestWrapper
    implements ResourceRequest
    The ResourceRequestWrapper provides a convenient implementation of the ResourceRequest interface that can be subclassed by developers wishing to adapt the request. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.
    Since:
    2.0
    See Also:
    ResourceRequest
    • Constructor Detail

      • ResourceRequestWrapper

        public ResourceRequestWrapper​(ResourceRequest request)
        Creates an ResourceRequest adaptor wrapping the given request object.
        Parameters:
        request - the resource request to wrap
        Throws:
        java.lang.IllegalArgumentException - if the request is null
    • Method Detail

      • getPortletInputStream

        public java.io.InputStream getPortletInputStream()
                                                  throws java.io.IOException
        The default behavior of this method is to call getPortletInputStream() on the wrapped request object.
        Specified by:
        getPortletInputStream in interface ClientDataRequest
        Returns:
        an input stream containing the body of the request
        Throws:
        java.io.IOException - if an input or output exception occurred
      • getReader

        public java.io.BufferedReader getReader()
                                         throws java.io.UnsupportedEncodingException,
                                                java.io.IOException
        The default behavior of this method is to call getReader() on the wrapped request object.
        Specified by:
        getReader in interface ClientDataRequest
        Returns:
        a BufferedReader containing the body of the request
        Throws:
        java.io.UnsupportedEncodingException - if the character set encoding used is not supported and the text cannot be decoded
        java.io.IOException - if an input or output exception occurred
        See Also:
        ClientDataRequest.getPortletInputStream()
      • setCharacterEncoding

        public void setCharacterEncoding​(java.lang.String enc)
                                  throws java.io.UnsupportedEncodingException
        The default behavior of this method is to call setCharacterEncoding(String enc) on the wrapped request object.
        Specified by:
        setCharacterEncoding in interface ClientDataRequest
        Parameters:
        enc - a String containing the name of the character encoding.
        Throws:
        java.io.UnsupportedEncodingException - if this is not a valid encoding
      • setRequest

        public void setRequest​(ResourceRequest request)
        Sets the request object being wrapped.
        Parameters:
        request - the request to set
        Throws:
        java.lang.IllegalArgumentException - if the request is null.
      • getCharacterEncoding

        public java.lang.String getCharacterEncoding()
        The default behavior of this method is to call getCharacterEncoding() on the wrapped request object.
        Specified by:
        getCharacterEncoding in interface ClientDataRequest
        Returns:
        a String containing the name of the character encoding, or null if the request does not specify a character encoding.
      • getContentLength

        public int getContentLength()
        The default behavior of this method is to call getContentLength() on the wrapped request object.
        Specified by:
        getContentLength in interface ClientDataRequest
        Returns:
        an integer containing the length of the request body or -1 if the length is not known
      • getContentType

        public java.lang.String getContentType()
        The default behavior of this method is to call getContentType() on the wrapped request object.
        Specified by:
        getContentType in interface ClientDataRequest
        Returns:
        a String containing the name of the MIME type of the request, or null if the type is not known.
      • getETag

        public java.lang.String getETag()
        The default behavior of this method is to call getETag() on the wrapped request object.
        Specified by:
        getETag in interface ResourceRequest
        Returns:
        the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists.
      • getMethod

        public java.lang.String getMethod()
        The default behavior of this method is to call getMethod() on the wrapped request object.
        Specified by:
        getMethod in interface ClientDataRequest
        Returns:
        a String specifying the name of the HTTP method with which this request was made
      • getResourceID

        public java.lang.String getResourceID()
        The default behavior of this method is to call getResourceID() on the wrapped request object.
        Specified by:
        getResourceID in interface ResourceRequest
        Returns:
        the resource ID set on the ResourceURL,or null if no resource ID was set on the URL.
      • getPrivateRenderParameterMap

        public java.util.Map<java.lang.String,​java.lang.String[]> getPrivateRenderParameterMap()
        The default behavior of this method is to call getPrivateRenderParameterMap() on the wrapped request object.
        Specified by:
        getPrivateRenderParameterMap in interface ResourceRequest
        Returns:
        an immutable Map containing private parameter names as keys and private parameter values as map values, or an empty Map if no private parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of type String array (String[]).
      • getCacheability

        public java.lang.String getCacheability()
        The default behavior of this method is to call getCacheability() on the wrapped response object.
        Specified by:
        getCacheability in interface ResourceRequest
        Returns:
        the cache level of this resource request.