Package org.apache.catalina.connector

Class ResponseFacade

  • All Implemented Interfaces:
    HttpServletResponse, ServletResponse
    public class ResponseFacade
extends java.lang.Object
implements HttpServletResponse
    Facade class that wraps a Coyote response object. All methods are delegated to the wrapped response.
    Author:
    Remy Maucherat

    • Field Detail

      • sm

        protected static final StringManager sm
        The string manager for this package.

      • response

        protected Response response
        The wrapped response.

    • Constructor Detail

      • ResponseFacade

        public ResponseFacade​(Response response)
        Construct a wrapper for the specified response.
        Parameters:
        response - The response to be wrapped

    • Method Detail

      • clear

        public void clear()
        Clear facade.

      • clone

        protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException
        Prevent cloning the facade.
        Overrides:
        clone in class java.lang.Object
        Throws:
        java.lang.CloneNotSupportedException

      • finish

        public void finish()

      • isFinished

        public boolean isFinished()

      • getContentWritten

        public long getContentWritten()

      • getWriter

        public java.io.PrintWriter getWriter()
                              throws java.io.IOException
        Description copied from interface: jakarta.servlet.ServletResponse
        Returns a PrintWriter object that can send character text to the client. The PrintWriter uses the character encoding returned by ServletResponse.getCharacterEncoding(). If the response's character encoding has not been specified as described in getCharacterEncoding (i.e., the method just returns the default value ISO-8859-1), getWriter updates it to ISO-8859-1.

        Calling flush() on the PrintWriter commits the response.

        Either this method or ServletResponse.getOutputStream() may be called to write the body, not both.

        Specified by:
        getWriter in interface ServletResponse
        Returns:
        a PrintWriter object that can return character data to the client
        Throws:
        java.io.UnsupportedEncodingException - if the character encoding returned by getCharacterEncoding cannot be used
        java.io.IOException - if an input or output exception occurred
        See Also:
        ServletResponse.getOutputStream(), ServletResponse.setCharacterEncoding(java.lang.String)

      • setContentLength

        public void setContentLength​(int len)
        Description copied from interface: jakarta.servlet.ServletResponse
        Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
        Specified by:
        setContentLength in interface ServletResponse
        Parameters:
        len - an integer specifying the length of the content being returned to the client; sets the Content-Length header

      • setContentLengthLong

        public void setContentLengthLong​(long length)
        Description copied from interface: jakarta.servlet.ServletResponse
        Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
        Specified by:
        setContentLengthLong in interface ServletResponse
        Parameters:
        length - an integer specifying the length of the content being returned to the client; sets the Content-Length header

      • setContentType

        public void setContentType​(java.lang.String type)
        Description copied from interface: jakarta.servlet.ServletResponse
        Sets the content type of the response being sent to the client, if the response has not been committed yet. The given content type may include a character encoding specification, for example, text/html;charset=UTF-8. The response's character encoding is only set from the given content type if this method is called before getWriter is called.

        This method may be called repeatedly to change content type and character encoding. This method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after getWriter has been called or after the response has been committed.

        Containers must communicate the content type and the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the Content-Type header is used.

        Specified by:
        setContentType in interface ServletResponse
        Parameters:
        type - a String specifying the MIME type of the content
        See Also:
        ServletResponse.setLocale(java.util.Locale), ServletResponse.setCharacterEncoding(java.lang.String), ServletResponse.getOutputStream(), ServletResponse.getWriter()

      • setBufferSize

        public void setBufferSize​(int size)
        Description copied from interface: jakarta.servlet.ServletResponse
        Sets the preferred buffer size for the body of the response. The servlet container will use a buffer at least as large as the size requested. The actual buffer size used can be found using getBufferSize.

        A larger buffer allows more content to be written before anything is actually sent, thus providing the servlet with more time to set appropriate status codes and headers. A smaller buffer decreases server memory load and allows the client to start receiving data more quickly.

        This method must be called before any response body content is written; if content has been written or the response object has been committed, this method throws an IllegalStateException.

        Specified by:
        setBufferSize in interface ServletResponse
        Parameters:
        size - the preferred buffer size
        See Also:
        ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.isCommitted(), ServletResponse.reset()

      • setLocale

        public void setLocale​(java.util.Locale loc)
        Description copied from interface: jakarta.servlet.ServletResponse
        Sets the locale of the response, if the response has not been committed yet. It also sets the response's character encoding appropriately for the locale, if the character encoding has not been explicitly set using ServletResponse.setContentType(java.lang.String) or ServletResponse.setCharacterEncoding(java.lang.String), getWriter hasn't been called yet, and the response hasn't been committed yet. If the deployment descriptor contains a locale-encoding-mapping-list element, and that element provides a mapping for the given locale, that mapping is used. Otherwise, the mapping from locale to character encoding is container dependent.

        This method may be called repeatedly to change locale and character encoding. The method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after ServletResponse.setContentType(java.lang.String) has been called with a charset specification, after ServletResponse.setCharacterEncoding(java.lang.String) has been called, after getWriter has been called, or after the response has been committed.

        Containers must communicate the locale and the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the locale is communicated via the Content-Language header, the character encoding as part of the Content-Type header for text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written via the servlet response's writer.

        Specified by:
        setLocale in interface ServletResponse
        Parameters:
        loc - the locale of the response
        See Also:
        ServletResponse.getLocale(), ServletResponse.setContentType(java.lang.String), ServletResponse.setCharacterEncoding(java.lang.String)

      • containsHeader

        public boolean containsHeader​(java.lang.String name)
        Description copied from interface: jakarta.servlet.http.HttpServletResponse
        Returns a boolean indicating whether the named response header has already been set.
        Specified by:
        containsHeader in interface HttpServletResponse
        Parameters:
        name - the header name
        Returns:
        true if the named response header has already been set; false otherwise

      • encodeURL

        public java.lang.String encodeURL​(java.lang.String url)
        Description copied from interface: jakarta.servlet.http.HttpServletResponse
        Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary.

        For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

        Specified by:
        encodeURL in interface HttpServletResponse
        Parameters:
        url - the url to be encoded.
        Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.

      • encodeRedirectURL

        public java.lang.String encodeRedirectURL​(java.lang.String url)
        Description copied from interface: jakarta.servlet.http.HttpServletResponse
        Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. Because the rules for making this determination can differ from those used to decide whether to encode a normal link, this method is separated from the encodeURL method.

        All URLs sent to the HttpServletResponse.sendRedirect method should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

        Specified by:
        encodeRedirectURL in interface HttpServletResponse
        Parameters:
        url - the url to be encoded.
        Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.
        See Also:
        HttpServletResponse.sendRedirect(java.lang.String), HttpServletResponse.encodeUrl(java.lang.String)

      • encodeUrl

        public java.lang.String encodeUrl​(java.lang.String url)
        Specified by:
        encodeUrl in interface HttpServletResponse
        Parameters:
        url - the url to be encoded.
        Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.

      • encodeRedirectUrl

        public java.lang.String encodeRedirectUrl​(java.lang.String url)
        Specified by:
        encodeRedirectUrl in interface HttpServletResponse
        Parameters:
        url - the url to be encoded.
        Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.

      • sendError

        public void sendError​(int sc,
                      java.lang.String msg)
               throws java.io.IOException
        Description copied from interface: jakarta.servlet.http.HttpServletResponse
        Sends an error response to the client using the specified status code and clears the output buffer. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html", leaving cookies and other headers unmodified. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter.

        If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

        Specified by:
        sendError in interface HttpServletResponse
        Parameters:
        sc - the error status code
        msg - the descriptive message
        Throws:
        java.io.IOException - If an input or output exception occurs

      • sendRedirect

        public void sendRedirect​(java.lang.String location)
                  throws java.io.IOException
        Description copied from interface: jakarta.servlet.http.HttpServletResponse
        Sends a temporary redirect response to the client using the specified redirect location URL. This method can accept relative URLs; the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.

        If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

        Specified by:
        sendRedirect in interface HttpServletResponse
        Parameters:
        location - the redirect location URL
        Throws:
        java.io.IOException - If an input or output exception occurs

      • setStatus

        public void setStatus​(int sc)
        Description copied from interface: jakarta.servlet.http.HttpServletResponse
        Sets the status code for this response. This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, and the caller wishes to invoke an error-page defined in the web application, the sendError method should be used instead.

        The container clears the buffer and sets the Location header, preserving cookies and other headers.

        Specified by:
        setStatus in interface HttpServletResponse
        Parameters:
        sc - the status code
        See Also:
        HttpServletResponse.sendError(int, java.lang.String)

      • getContentType

        public java.lang.String getContentType()
        Description copied from interface: jakarta.servlet.ServletResponse
        Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using ServletResponse.setContentType(java.lang.String) before the response is committed. If no content type has been specified, this method returns null. If a content type has been specified and a character encoding has been explicitly or implicitly specified as described in ServletResponse.getCharacterEncoding(), the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.
        Specified by:
        getContentType in interface ServletResponse
        Returns:
        a String specifying the content type, for example, text/html; charset=UTF-8, or null

      • setCharacterEncoding

        public void setCharacterEncoding​(java.lang.String arg0)
        Description copied from interface: jakarta.servlet.ServletResponse
        Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the character encoding has already been set by container default, ServletContext default, ServletResponse.setContentType(java.lang.String) or ServletResponse.setLocale(java.util.Locale), this method overrides it. Calling ServletResponse.setContentType(java.lang.String) with the String of text/html and calling this method with the String of UTF-8 is equivalent with calling setContentType with the String of text/html; charset=UTF-8.

        This method can be called repeatedly to change the character encoding. This method has no effect if it is called after getWriter has been called or after the response has been committed.

        Containers must communicate the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the character encoding is communicated as part of the Content-Type header for text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written via the servlet response's writer.

        Specified by:
        setCharacterEncoding in interface ServletResponse
        Parameters:
        arg0 - a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)
        See Also:
        #setLocale

      • getHeader

        public java.lang.String getHeader​(java.lang.String name)
        Description copied from interface: jakarta.servlet.http.HttpServletResponse
        Return the value for the specified header, or null if this header has not been set. If more than one value was added for this name, only the first is returned; use HttpServletResponse.getHeaders(String) to retrieve all of them.
        Specified by:
        getHeader in interface HttpServletResponse
        Parameters:
        name - Header name to look up
        Returns:
        The first value for the specified header. This is the raw value so if multiple values are specified in the first header then they will be returned as a single header value .

      • getHeaders

        public java.util.Collection<java.lang.String> getHeaders​(java.lang.String name)
        Description copied from interface: jakarta.servlet.http.HttpServletResponse
        Return a Collection of all the header values associated with the specified header name.
        Specified by:
        getHeaders in interface HttpServletResponse
        Parameters:
        name - Header name to look up
        Returns:
        The values for the specified header. These are the raw values so if multiple values are specified in a single header that will be returned as a single header value.

      • setTrailerFields

        public void setTrailerFields​(java.util.function.Supplier<java.util.Map<java.lang.String,​java.lang.String>> supplier)
        Description copied from interface: jakarta.servlet.http.HttpServletResponse
        Configure the supplier of the trailer headers. The supplier will be called in the scope of the thread that completes the response.
        Trailers that don't meet the requirements of RFC 7230, section 4.1.2 will be ignored.
        The default implementation is a NO-OP.
        Specified by:
        setTrailerFields in interface HttpServletResponse
        Parameters:
        supplier - The supplier for the trailer headers

      • getTrailerFields

        public java.util.function.Supplier<java.util.Map<java.lang.String,​java.lang.String>> getTrailerFields()
        Description copied from interface: jakarta.servlet.http.HttpServletResponse
        Obtain the supplier of the trailer headers.
        The default implementation returns null.
        Specified by:
        getTrailerFields in interface HttpServletResponse
        Returns:
        The supplier for the trailer headers