Package org.eclipse.jetty.server

Class Response

    • Method Detail

      • getHttpChannel

        public HttpChannel getHttpChannel()
        Deprecated.

      • getHttpOutput

        public HttpOutput getHttpOutput()
        Deprecated.

      • reopen

        public void reopen()
        Deprecated.

      • errorClose

        public void errorClose()
        Deprecated.

      • isIncluding

        public boolean isIncluding()
        Deprecated.

      • include

        public void include()
        Deprecated.

      • included

        public void included()
        Deprecated.

      • addCookie

        public void addCookie​(HttpCookie cookie)
        Deprecated.

      • replaceCookie

        public void replaceCookie​(HttpCookie cookie)
        Deprecated.
        Replace (or add) a cookie. Using name, path and domain, look for a matching set-cookie header and replace it.
        Parameters:
        cookie - The cookie to add/replace

      • addCookie

        public void addCookie​(Cookie cookie)
        Deprecated.
        Description copied from interface: HttpServletResponse
        Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.
        Specified by:
        addCookie in interface HttpServletResponse
        Parameters:
        cookie - the Cookie to return to the client

      • containsHeader

        public boolean containsHeader​(java.lang.String name)
        Deprecated.
        Description copied from interface: 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)
        Deprecated.
        Description copied from interface: 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)
        Deprecated.
        Description copied from interface: 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

        @Deprecated
public java.lang.String encodeUrl​(java.lang.String url)
        Deprecated.
        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

        @Deprecated
public java.lang.String encodeRedirectUrl​(java.lang.String url)
        Deprecated.
        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)
               throws java.io.IOException
        Deprecated.
        Description copied from interface: HttpServletResponse
        Sends an error response to the client using the specified status code and clears the buffer. This is equivalent to calling HttpServletResponse.sendError(int, String) with the same status code and null for the message.
        Specified by:
        sendError in interface HttpServletResponse
        Parameters:
        sc - the error status code
        Throws:
        java.io.IOException - If an input or output exception occurs

      • sendError

        public void sendError​(int code,
                      java.lang.String message)
               throws java.io.IOException
        Deprecated.
        Send an error response.

        In addition to the servlet standard handling, this method supports some additional codes:

        102
        Send a partial PROCESSING response and allow additional responses
        -1
        Abort the HttpChannel and close the connection/stream
        Specified by:
        sendError in interface HttpServletResponse
        Parameters:
        code - The error code
        message - The message
        Throws:
        java.io.IOException - If an IO problem occurred sending the error response.

      • sendProcessing

        public void sendProcessing()
                    throws java.io.IOException
        Deprecated.
        Sends a 102-Processing response. If the connection is an HTTP connection, the version is 1.1 and the request has a Expect header starting with 102, then a 102 response is sent. This indicates that the request still be processed and real response can still be sent. This method is called by sendError if it is passed 102.
        Throws:
        java.io.IOException - if unable to send the 102 response
        See Also:
        HttpServletResponse.sendError(int)

      • sendRedirect

        public void sendRedirect​(int code,
                         java.lang.String location)
                  throws java.io.IOException
        Deprecated.
        Sends a response with one of the 300 series redirection codes.
        Parameters:
        code - the redirect status code
        location - the location to send in Location headers
        Throws:
        java.io.IOException - if unable to send the redirect

      • sendRedirect

        public void sendRedirect​(java.lang.String location,
                         boolean consumeAll)
                  throws java.io.IOException
        Deprecated.
        Sends a response with a HTTP version appropriate 30x redirection.
        Parameters:
        location - the location to send in Location headers
        consumeAll - if True, consume any HTTP/1 request input before doing the redirection. If the input cannot be consumed without blocking, then add a `Connection: close` header to the response.
        Throws:
        java.io.IOException - if unable to send the redirect

      • sendRedirect

        public void sendRedirect​(int code,
                         java.lang.String location,
                         boolean consumeAll)
                  throws java.io.IOException
        Deprecated.
        Sends a response with a given redirection code.
        Parameters:
        code - the redirect status code
        location - the location to send in Location headers
        consumeAll - if True, consume any HTTP/1 request input before doing the redirection. If the input cannot be consumed without blocking, then add a `Connection: close` header to the response.
        Throws:
        java.io.IOException - if unable to send the redirect

      • sendRedirect

        public void sendRedirect​(java.lang.String location)
                  throws java.io.IOException
        Deprecated.
        Description copied from interface: 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

      • addDateHeader

        public void addDateHeader​(java.lang.String name,
                          long date)
        Deprecated.
        Description copied from interface: HttpServletResponse
        Adds a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. This method allows response headers to have multiple values.
        Specified by:
        addDateHeader in interface HttpServletResponse
        Parameters:
        name - the name of the header to set
        date - the additional date value
        See Also:
        HttpServletResponse.setDateHeader(java.lang.String, long)

      • setHeader

        public void setHeader​(HttpHeader name,
                      java.lang.String value)
        Deprecated.

      • getHeaderNames

        public java.util.Collection<java.lang.String> getHeaderNames()
        Deprecated.
        Description copied from interface: HttpServletResponse
        Get the header names set for this HTTP response.
        Specified by:
        getHeaderNames in interface HttpServletResponse
        Returns:
        The header names set for this HTTP response.

      • getHeader

        public java.lang.String getHeader​(java.lang.String name)
        Deprecated.
        Description copied from interface: 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)
        Deprecated.
        Description copied from interface: 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.

      • addHeader

        public void addHeader​(java.lang.String name,
                      java.lang.String value)
        Deprecated.
        Description copied from interface: HttpServletResponse
        Adds a response header with the given name and value. This method allows response headers to have multiple values.
        Specified by:
        addHeader in interface HttpServletResponse
        Parameters:
        name - the name of the header
        value - the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
        See Also:
        HttpServletResponse.setHeader(java.lang.String, java.lang.String)

      • setStatus

        public void setStatus​(int sc)
        Deprecated.
        Description copied from interface: 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)

      • setStatus

        @Deprecated
public void setStatus​(int sc,
                      java.lang.String sm)
        Deprecated.
        Description copied from interface: HttpServletResponse
        Sets the status code and message for this response.
        Specified by:
        setStatus in interface HttpServletResponse
        Parameters:
        sc - the status code
        sm - the status message

      • setStatusWithReason

        public void setStatusWithReason​(int sc,
                                java.lang.String sm)
        Deprecated.

      • getCharacterEncoding

        public java.lang.String getCharacterEncoding()
        Deprecated.
        Description copied from interface: ServletResponse
        Returns the name of the character encoding (MIME charset) used for the body sent in this response. The character encoding may have been specified explicitly using the ServletResponse.setCharacterEncoding(java.lang.String) or ServletResponse.setContentType(java.lang.String) methods, or implicitly using the ServletResponse.setLocale(java.util.Locale) method. Explicit specifications take precedence over implicit specifications. Calls made to these methods after getWriter has been called or after the response has been committed have no effect on the character encoding. If no character encoding has been specified, ISO-8859-1 is returned.

        See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.

        Specified by:
        getCharacterEncoding in interface ServletResponse
        Returns:
        a String specifying the name of the character encoding, for example, UTF-8

      • getContentType

        public java.lang.String getContentType()
        Deprecated.
        Description copied from interface: 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

      • isWriting

        public boolean isWriting()
        Deprecated.

      • isStreaming

        public boolean isStreaming()
        Deprecated.

      • isWritingOrStreaming

        public boolean isWritingOrStreaming()
        Deprecated.

      • getWriter

        public java.io.PrintWriter getWriter()
                              throws java.io.IOException
        Deprecated.
        Description copied from interface: 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)
        Deprecated.
        Description copied from interface: 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

      • getContentLength

        public long getContentLength()
        Deprecated.

      • isAllContentWritten

        public boolean isAllContentWritten​(long written)
        Deprecated.

      • isContentComplete

        public boolean isContentComplete​(long written)
        Deprecated.

      • closeOutput

        public void closeOutput()
                 throws java.io.IOException
        Deprecated.
        Throws:
        java.io.IOException

      • completeOutput

        @Deprecated
public void completeOutput()
                    throws java.io.IOException
        Deprecated.
        Use closeOutput()
        close the output
        Throws:
        java.io.IOException

      • completeOutput

        public void completeOutput​(Callback callback)
        Deprecated.

      • getLongContentLength

        public long getLongContentLength()
        Deprecated.

      • setLongContentLength

        public void setLongContentLength​(long len)
        Deprecated.

      • setContentLengthLong

        public void setContentLengthLong​(long length)
        Deprecated.
        Description copied from interface: 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 encoding)
        Deprecated.
        Description copied from interface: 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 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:
        encoding - a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)
        See Also:
        #setLocale

      • setContentType

        public void setContentType​(java.lang.String contentType)
        Deprecated.
        Description copied from interface: 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:
        contentType - 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)
        Deprecated.
        Description copied from interface: 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()

      • resetContent

        public void resetContent()
        Deprecated.

      • resetForForward

        public void resetForForward()
        Deprecated.

      • setTrailers

        public void setTrailers​(java.util.function.Supplier<HttpFields> trailers)
        Deprecated.

      • getTrailers

        public java.util.function.Supplier<HttpFields> getTrailers()
        Deprecated.

      • getCommittedMetaData

        public MetaData.Response getCommittedMetaData()
        Deprecated.
        Get the MetaData.Response committed for this response. This may differ from the meta data in this response for exceptional responses (eg 4xx and 5xx responses generated by the container) and the committedMetaData should be used for logging purposes.
        Returns:
        The committed MetaData or a newResponseMetaData() if not yet committed.

      • setLocale

        public void setLocale​(java.util.Locale locale)
        Deprecated.
        Description copied from interface: 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:
        locale - the locale of the response
        See Also:
        ServletResponse.getLocale(), ServletResponse.setContentType(java.lang.String), ServletResponse.setCharacterEncoding(java.lang.String)

      • getStatus

        public int getStatus()
        Deprecated.
        Description copied from interface: HttpServletResponse
        Get the HTTP status code for this Response.
        Specified by:
        getStatus in interface HttpServletResponse
        Returns:
        The HTTP status code for this Response

      • getReason

        public java.lang.String getReason()
        Deprecated.

      • getHttpFields

        public HttpFields getHttpFields()
        Deprecated.

      • getContentCount

        public long getContentCount()
        Deprecated.

      • toString

        public java.lang.String toString()
        Deprecated.
        Overrides:
        toString in class java.lang.Object

      • putHeaders

        public void putHeaders​(HttpContent content,
                       long contentLength,
                       boolean etag)
        Deprecated.