Package org.apache.catalina.connector

Class Response

    • Field Detail

      • coyoteResponse

        protected Response coyoteResponse
        Coyote response.

      • outputBuffer

        protected final OutputBuffer outputBuffer
        The associated output buffer.

      • writer

        protected CoyoteWriter writer
        The associated writer.

      • appCommitted

        protected boolean appCommitted
        The application commit flag.

      • included

        protected boolean included
        The included flag.

      • usingOutputStream

        protected boolean usingOutputStream
        Using output stream flag.

      • usingWriter

        protected boolean usingWriter
        Using writer flag.

      • urlEncoder

        protected final UEncoder urlEncoder
        URL encoder.

      • redirectURLCC

        protected final CharChunk redirectURLCC
        Recyclable buffer to hold the redirect URL.

      • request

        protected Request request
        The request with which this response is associated.

      • facade

        protected ResponseFacade facade
        The facade associated with this response.

    • Constructor Detail

      • Response

        public Response()

      • Response

        public Response​(int outputBufferSize)

    • Method Detail

      • setCoyoteResponse

        public void setCoyoteResponse​(Response coyoteResponse)
        Set the Coyote response.
        Parameters:
        coyoteResponse - The Coyote response

      • getCoyoteResponse

        public Response getCoyoteResponse()
        Returns:
        the Coyote response.

      • getContext

        public Context getContext()
        Returns:
        the Context within which this Request is being processed.

      • recycle

        public void recycle()
        Release all object references, and initialize instance variables, in preparation for reuse of this object.

      • getCookies

        public java.util.List<Cookie> getCookies()

      • getContentWritten

        public long getContentWritten()
        Returns:
        the number of bytes the application has actually written to the output stream. This excludes chunking, compression, etc. as well as headers.

      • getBytesWritten

        public long getBytesWritten​(boolean flush)
        Parameters:
        flush - if true will perform a buffer flush first
        Returns:
        the number of bytes the actually written to the socket. This includes chunking, compression, etc. but excludes headers.

      • setAppCommitted

        public void setAppCommitted​(boolean appCommitted)
        Set the application commit flag.
        Parameters:
        appCommitted - The new application committed flag value

      • isAppCommitted

        public boolean isAppCommitted()
        Application commit flag accessor.
        Returns:
        true if the application has committed the response

      • getRequest

        public Request getRequest()
        Returns:
        the Request with which this Response is associated.

      • setRequest

        public void setRequest​(Request request)
        Set the Request with which this Response is associated.
        Parameters:
        request - The new associated request

      • getResponse

        public HttpServletResponse getResponse()
        Returns:
        the ServletResponse for which this object is the facade.

      • setResponse

        public void setResponse​(HttpServletResponse applicationResponse)
        Set a wrapped HttpServletResponse to pass to the application. Components wishing to wrap the response should obtain the response via getResponse(), wrap it and then call this method with the wrapped response.
        Parameters:
        applicationResponse - The wrapped response to pass to the application

      • setSuspended

        public void setSuspended​(boolean suspended)
        Set the suspended flag.
        Parameters:
        suspended - The new suspended flag value

      • isSuspended

        public boolean isSuspended()
        Suspended flag accessor.
        Returns:
        true if the response is suspended

      • isClosed

        public boolean isClosed()
        Closed flag accessor.
        Returns:
        true if the response has been closed

      • setError

        public boolean setError()
        Set the error flag.
        Returns:
        false if the error flag was already set

      • isError

        public boolean isError()
        Error flag accessor.
        Returns:
        true if the response has encountered an error

      • isErrorReportRequired

        public boolean isErrorReportRequired()

      • setErrorReported

        public boolean setErrorReported()

      • finishResponse

        public void finishResponse()
                    throws java.io.IOException
        Perform whatever actions are required to flush and close the output stream or writer, in a single operation.
        Throws:
        java.io.IOException - if an input/output error occurs

      • getContentLength

        public int getContentLength()
        Returns:
        the content length that was set or calculated for this Response.

      • 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:
        the content type that was set or calculated for this response, or null if no content type was set.

      • getReporter

        public java.io.PrintWriter getReporter()
                                throws java.io.IOException
        Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired.
        Returns:
        Writer which can be used for error reports. If the response is not an error report returned using sendError or triggered by an unexpected exception thrown during the servlet processing (and only in that case), null will be returned if the response stream has already been used.
        Throws:
        java.io.IOException - if an input/output error occurs

      • getOutputStream

        public ServletOutputStream getOutputStream()
                                    throws java.io.IOException
        Description copied from interface: jakarta.servlet.ServletResponse
        Returns a ServletOutputStream suitable for writing binary data in the response. The servlet container does not encode the binary data.

        Calling flush() on the ServletOutputStream commits the response. Either this method or ServletResponse.getWriter() may be called to write the body, not both.

        Specified by:
        getOutputStream in interface ServletResponse
        Returns:
        the servlet output stream associated with this Response.
        Throws:
        java.lang.IllegalStateException - if getWriter has already been called for this response
        java.io.IOException - if an input/output error occurs
        See Also:
        ServletResponse.getWriter()

      • resetBuffer

        public void resetBuffer​(boolean resetWriterStreamFlags)
        Reset the data buffer and the using Writer/Stream flags but not any status or header information.
        Parameters:
        resetWriterStreamFlags - true if the internal usingWriter, usingOutputStream, isCharacterEncodingSet flags should also be reset
        Throws:
        java.lang.IllegalStateException - if the response has already been committed

      • setContentLength

        public void setContentLength​(int length)
        Set the content length (in bytes) for this Response.
        Specified by:
        setContentLength in interface ServletResponse
        Parameters:
        length - The new content length

      • 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

      • setCharacterEncoding

        public void setCharacterEncoding​(java.lang.String charset)
        Overrides the name of the character encoding used in the body of the request. This method must be called prior to reading request parameters or reading input using getReader().
        Specified by:
        setCharacterEncoding in interface ServletResponse
        Parameters:
        charset - String containing the name of the character encoding.
        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.

      • getMessage

        public java.lang.String getMessage()
        Returns:
        the error message that was set with sendError() for this Response.

      • addCookie

        public void addCookie​(Cookie cookie)
        Add the specified Cookie to those that will be included with this Response.
        Specified by:
        addCookie in interface HttpServletResponse
        Parameters:
        cookie - Cookie to be added

      • addSessionCookieInternal

        public void addSessionCookieInternal​(Cookie cookie)
        Special method for adding a session cookie as we should be overriding any previous.
        Parameters:
        cookie - The new session cookie to add the response

      • generateCookieString

        public java.lang.String generateCookieString​(Cookie cookie)

      • containsHeader

        public boolean containsHeader​(java.lang.String name)
        Has the specified header been set already in this response?
        Specified by:
        containsHeader in interface HttpServletResponse
        Parameters:
        name - Name of the header to check
        Returns:
        true if the header has been set

      • 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

      • encodeRedirectUrl

        @Deprecated
public java.lang.String encodeRedirectUrl​(java.lang.String url)
        Deprecated.
        As of Version 2.1 of the Java Servlet API, use encodeRedirectURL() instead.
        Encode the session identifier associated with this response into the specified redirect URL, if necessary.
        Specified by:
        encodeRedirectUrl in interface HttpServletResponse
        Parameters:
        url - URL to be encoded
        Returns:
        true if the URL was encoded

      • encodeURL

        public java.lang.String encodeURL​(java.lang.String url)
        Encode the session identifier associated with this response into the specified URL, if necessary.
        Specified by:
        encodeURL in interface HttpServletResponse
        Parameters:
        url - URL to be encoded
        Returns:
        true if the URL was encoded

      • encodeUrl

        @Deprecated
public java.lang.String encodeUrl​(java.lang.String url)
        Deprecated.
        As of Version 2.1 of the Java Servlet API, use encodeURL() instead.
        Encode the session identifier associated with this response into the specified URL, if necessary.
        Specified by:
        encodeUrl in interface HttpServletResponse
        Parameters:
        url - URL to be encoded
        Returns:
        true if the URL was encoded

      • sendAcknowledgement

        public void sendAcknowledgement​(ContinueResponseTiming continueResponseTiming)
                         throws java.io.IOException
        Send an acknowledgement of a request.
        Parameters:
        continueResponseTiming - Indicates when the request for the ACK originated so it can be compared with the configured timing for ACK responses.
        Throws:
        java.io.IOException - if an input/output error occurs

      • sendError

        public void sendError​(int status)
               throws java.io.IOException
        Send an error response with the specified status and a default message.
        Specified by:
        sendError in interface HttpServletResponse
        Parameters:
        status - HTTP status code to send
        Throws:
        java.lang.IllegalStateException - if this response has already been committed
        java.io.IOException - if an input/output error occurs

      • sendError

        public void sendError​(int status,
                      java.lang.String message)
               throws java.io.IOException
        Send an error response with the specified status and message.
        Specified by:
        sendError in interface HttpServletResponse
        Parameters:
        status - HTTP status code to send
        message - Corresponding message to send
        Throws:
        java.lang.IllegalStateException - if this response has already been committed
        java.io.IOException - if an input/output error occurs

      • sendRedirect

        public void sendRedirect​(java.lang.String location)
                  throws java.io.IOException
        Send a temporary redirect to the specified redirect location URL.
        Specified by:
        sendRedirect in interface HttpServletResponse
        Parameters:
        location - Location URL to redirect to
        Throws:
        java.lang.IllegalStateException - if this response has already been committed
        java.io.IOException - if an input/output error occurs

      • sendRedirect

        public void sendRedirect​(java.lang.String location,
                         int status)
                  throws java.io.IOException
        Internal method that allows a redirect to be sent with a status other than HttpServletResponse.SC_FOUND (302). No attempt is made to validate the status code.
        Parameters:
        location - Location URL to redirect to
        status - HTTP status code that will be sent
        Throws:
        java.io.IOException - an IO exception occurred

      • setStatus

        @Deprecated
public void setStatus​(int status,
                      java.lang.String message)
        Deprecated.
        As of Version 2.1 of the Java Servlet API, this method has been deprecated due to the ambiguous meaning of the message parameter.
        Set the HTTP status and message to be returned with this response.
        Specified by:
        setStatus in interface HttpServletResponse
        Parameters:
        status - The new HTTP status
        message - The associated text message

      • isEncodeable

        protected boolean isEncodeable​(java.lang.String location)
        Return true if the specified URL should be encoded with a session identifier. This will be true if all of the following conditions are met:
        • The request we are responding to asked for a valid session
        • The requested session ID was not received via a cookie
        • The specified URL points back to somewhere within the web application that is responding to this request
        Parameters:
        location - Absolute URL to be validated
        Returns:
        true if the URL should be encoded

      • toAbsolute

        protected java.lang.String toAbsolute​(java.lang.String location)
        Convert (if necessary) and return the absolute URL that represents the resource referenced by this possibly relative URL. If this URL is already absolute, return it unchanged.
        Parameters:
        location - URL to be (possibly) converted and then returned
        Returns:
        the encoded URL
        Throws:
        java.lang.IllegalArgumentException - if a MalformedURLException is thrown when converting the relative URL to an absolute one

      • toEncoded

        protected java.lang.String toEncoded​(java.lang.String url,
                                     java.lang.String sessionId)
        Return the specified URL with the specified session identifier suitably encoded.
        Parameters:
        url - URL to be encoded with the session id
        sessionId - Session id to be included in the encoded URL
        Returns:
        the encoded URL