java.lang.Object
- org.eclipse.jetty.server.Response

All Implemented Interfaces:

jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse
```
public class Response
extends java.lang.Object
implements jakarta.servlet.http.HttpServletResponse
```
Response provides the implementation for HttpServletResponse.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Response.OutputType

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`NO_CONTENT_LENGTH`
`static java.lang.String`	`SET_INCLUDE_HEADER_PREFIX`	If a header name starts with this string, the header (stripped of the prefix) can be set during include using only `setHeader(String, String)` or `addHeader(String, String)`.
`static int`	`USE_KNOWN_CONTENT_LENGTH`

Fields inherited from interface jakarta.servlet.http.HttpServletResponse
SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors
Constructor Description

Response(HttpChannel channel, HttpOutput out)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addCookie(jakarta.servlet.http.Cookie cookie)`
`void`	`addCookie(org.eclipse.jetty.http.HttpCookie cookie)`
`void`	`addDateHeader(java.lang.String name, long date)`
`void`	`addHeader(java.lang.String name, java.lang.String value)`
`void`	`addIntHeader(java.lang.String name, int value)`
`void`	`closeOutput()`
`void`	`completeOutput()`	Deprecated. Use `closeOutput()`
`void`	`completeOutput(org.eclipse.jetty.util.Callback callback)`
`boolean`	`containsHeader(java.lang.String name)`
`java.lang.String`	`encodeRedirectUrl(java.lang.String url)`	Deprecated.
`java.lang.String`	`encodeRedirectURL(java.lang.String url)`
`java.lang.String`	`encodeUrl(java.lang.String url)`	Deprecated.
`java.lang.String`	`encodeURL(java.lang.String url)`
`void`	`errorClose()`
`void`	`flushBuffer()`
`int`	`getBufferSize()`
`java.lang.String`	`getCharacterEncoding()`
`org.eclipse.jetty.http.MetaData.Response`	`getCommittedMetaData()`	Get the MetaData.Response committed for this response.
`long`	`getContentCount()`
`long`	`getContentLength()`
`java.lang.String`	`getContentType()`
`java.lang.String`	`getHeader(java.lang.String name)`
`java.util.Collection<java.lang.String>`	`getHeaderNames()`
`java.util.Collection<java.lang.String>`	`getHeaders(java.lang.String name)`
`HttpChannel`	`getHttpChannel()`
`org.eclipse.jetty.http.HttpFields.Mutable`	`getHttpFields()`
`HttpOutput`	`getHttpOutput()`
`java.util.Locale`	`getLocale()`
`long`	`getLongContentLength()`
`jakarta.servlet.ServletOutputStream`	`getOutputStream()`
`java.lang.String`	`getReason()`
`int`	`getStatus()`
`java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>>`	`getTrailerFields()`
`java.util.function.Supplier<org.eclipse.jetty.http.HttpFields>`	`getTrailers()`
`java.io.PrintWriter`	`getWriter()`
`void`	`include()`
`void`	`included()`
`boolean`	`isAllContentWritten(long written)`
`boolean`	`isCommitted()`
`boolean`	`isContentComplete(long written)`
`boolean`	`isIncluding()`
`boolean`	`isStreaming()`
`boolean`	`isWriting()`
`boolean`	`isWritingOrStreaming()`
`protected org.eclipse.jetty.http.MetaData.Response`	`newResponseMetaData()`
`static void`	`putHeaders(jakarta.servlet.http.HttpServletResponse response, org.eclipse.jetty.http.HttpContent content, long contentLength, boolean etag)`
`void`	`putHeaders(org.eclipse.jetty.http.HttpContent content, long contentLength, boolean etag)`
`protected void`	`recycle()`
`void`	`reopen()`
`void`	`replaceCookie(org.eclipse.jetty.http.HttpCookie cookie)`	Replace (or add) a cookie.
`void`	`reset()`
`void`	`resetBuffer()`
`void`	`resetContent()`
`void`	`resetForForward()`
`void`	`sendError(int sc)`
`void`	`sendError(int code, java.lang.String message)`	Send an error response.
`void`	`sendProcessing()`	Sends a 102-Processing response.
`void`	`sendRedirect(int code, java.lang.String location)`	Sends a response with one of the 300 series redirection codes.
`void`	`sendRedirect(int code, java.lang.String location, boolean consumeAll)`	Sends a response with a given redirection code.
`void`	`sendRedirect(java.lang.String location)`
`void`	`sendRedirect(java.lang.String location, boolean consumeAll)`	Sends a response with a HTTP version appropriate 30x redirection.
`void`	`setBufferSize(int size)`
`void`	`setCharacterEncoding(java.lang.String encoding)`
`void`	`setContentLength(int len)`
`void`	`setContentLengthLong(long length)`
`void`	`setContentType(java.lang.String contentType)`
`void`	`setDateHeader(java.lang.String name, long date)`
`void`	`setHeader(java.lang.String name, java.lang.String value)`
`void`	`setHeader(org.eclipse.jetty.http.HttpHeader name, java.lang.String value)`
`void`	`setIntHeader(java.lang.String name, int value)`
`void`	`setLocale(java.util.Locale locale)`
`void`	`setLongContentLength(long len)`
`void`	`setStatus(int sc)`
`void`	`setStatus(int sc, java.lang.String message)`	Deprecated.
`void`	`setStatusWithReason(int sc, java.lang.String message)`
`void`	`setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> trailers)`
`void`	`setTrailers(java.util.function.Supplier<org.eclipse.jetty.http.HttpFields> trailers)`
`java.lang.String`	`toString()`
`static jakarta.servlet.http.HttpServletResponse`	`unwrap(jakarta.servlet.ServletResponse servletResponse)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_CONTENT_LENGTH
```
public static final int NO_CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
  - USE_KNOWN_CONTENT_LENGTH
```
public static final int USE_KNOWN_CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
  - SET_INCLUDE_HEADER_PREFIX
```
public static final java.lang.String SET_INCLUDE_HEADER_PREFIX
```
    If a header name starts with this string, the header (stripped of the prefix) can be set during include using only setHeader(String, String) or addHeader(String, String).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Response
```
public Response(HttpChannel channel,
                HttpOutput out)
```
- Method Detail
  - getHttpChannel
```
public HttpChannel getHttpChannel()
```
  - recycle
```
protected void recycle()
```
  - getHttpOutput
```
public HttpOutput getHttpOutput()
```
  - reopen
```
public void reopen()
```
  - errorClose
```
public void errorClose()
```
  - isIncluding
```
public boolean isIncluding()
```
  - include
```
public void include()
```
  - included
```
public void included()
```
  - addCookie
```
public void addCookie(org.eclipse.jetty.http.HttpCookie cookie)
```
  - addCookie
```
public void addCookie(jakarta.servlet.http.Cookie cookie)
```
    Specified by:
    
    addCookie in interface jakarta.servlet.http.HttpServletResponse
  - replaceCookie
```
public void replaceCookie(org.eclipse.jetty.http.HttpCookie cookie)
```
    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
  - containsHeader
```
public boolean containsHeader(java.lang.String name)
```
    Specified by:
    
    containsHeader in interface jakarta.servlet.http.HttpServletResponse
  - encodeURL
```
public java.lang.String encodeURL(java.lang.String url)
```
    Specified by:
    
    encodeURL in interface jakarta.servlet.http.HttpServletResponse
  - encodeRedirectURL
```
public java.lang.String encodeRedirectURL(java.lang.String url)
```
    Specified by:
    
    encodeRedirectURL in interface jakarta.servlet.http.HttpServletResponse
  - encodeUrl
```
@Deprecated(since="Servlet API 2.1")
public java.lang.String encodeUrl(java.lang.String url)
```
    Deprecated.
    
    Specified by:
    
    encodeUrl in interface jakarta.servlet.http.HttpServletResponse
  - encodeRedirectUrl
```
@Deprecated(since="Servlet API 2.1")
public java.lang.String encodeRedirectUrl(java.lang.String url)
```
    Deprecated.
    
    Specified by:
    
    encodeRedirectUrl in interface jakarta.servlet.http.HttpServletResponse
  - sendError
```
public void sendError(int sc)
               throws java.io.IOException
```
    Specified by:
    
    sendError in interface jakarta.servlet.http.HttpServletResponse
    
    Throws:
    
    java.io.IOException
  - sendError
```
public void sendError(int code,
                      java.lang.String message)
               throws java.io.IOException
```
    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 jakarta.servlet.http.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
```
    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
```
    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
```
    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
```
    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
```
    Specified by:
    
    sendRedirect in interface jakarta.servlet.http.HttpServletResponse
    
    Throws:
    
    java.io.IOException
  - setDateHeader
```
public void setDateHeader(java.lang.String name,
                          long date)
```
    Specified by:
    
    setDateHeader in interface jakarta.servlet.http.HttpServletResponse
  - addDateHeader
```
public void addDateHeader(java.lang.String name,
                          long date)
```
    Specified by:
    
    addDateHeader in interface jakarta.servlet.http.HttpServletResponse
  - setHeader
```
public void setHeader(org.eclipse.jetty.http.HttpHeader name,
                      java.lang.String value)
```
  - setHeader
```
public void setHeader(java.lang.String name,
                      java.lang.String value)
```
    Specified by:
    
    setHeader in interface jakarta.servlet.http.HttpServletResponse
  - getHeaderNames
```
public java.util.Collection<java.lang.String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface jakarta.servlet.http.HttpServletResponse
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Specified by:
    
    getHeader in interface jakarta.servlet.http.HttpServletResponse
  - getHeaders
```
public java.util.Collection<java.lang.String> getHeaders(java.lang.String name)
```
    Specified by:
    
    getHeaders in interface jakarta.servlet.http.HttpServletResponse
  - addHeader
```
public void addHeader(java.lang.String name,
                      java.lang.String value)
```
    Specified by:
    
    addHeader in interface jakarta.servlet.http.HttpServletResponse
  - setIntHeader
```
public void setIntHeader(java.lang.String name,
                         int value)
```
    Specified by:
    
    setIntHeader in interface jakarta.servlet.http.HttpServletResponse
  - addIntHeader
```
public void addIntHeader(java.lang.String name,
                         int value)
```
    Specified by:
    
    addIntHeader in interface jakarta.servlet.http.HttpServletResponse
  - setStatus
```
public void setStatus(int sc)
```
    Specified by:
    
    setStatus in interface jakarta.servlet.http.HttpServletResponse
  - setStatus
```
@Deprecated(since="Servlet API 2.1")
public void setStatus(int sc,
                      java.lang.String message)
```
    Deprecated.
    
    Specified by:
    
    setStatus in interface jakarta.servlet.http.HttpServletResponse
  - setStatusWithReason
```
public void setStatusWithReason(int sc,
                                java.lang.String message)
```
  - getCharacterEncoding
```
public java.lang.String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface jakarta.servlet.ServletResponse
  - getContentType
```
public java.lang.String getContentType()
```
    Specified by:
    
    getContentType in interface jakarta.servlet.ServletResponse
  - getOutputStream
```
public jakarta.servlet.ServletOutputStream getOutputStream()
                                                    throws java.io.IOException
```
    Specified by:
    
    getOutputStream in interface jakarta.servlet.ServletResponse
    
    Throws:
    
    java.io.IOException
  - isWriting
```
public boolean isWriting()
```
  - isStreaming
```
public boolean isStreaming()
```
  - isWritingOrStreaming
```
public boolean isWritingOrStreaming()
```
  - getWriter
```
public java.io.PrintWriter getWriter()
                              throws java.io.IOException
```
    Specified by:
    
    getWriter in interface jakarta.servlet.ServletResponse
    
    Throws:
    
    java.io.IOException
  - setContentLength
```
public void setContentLength(int len)
```
    Specified by:
    
    setContentLength in interface jakarta.servlet.ServletResponse
  - getContentLength
```
public long getContentLength()
```
  - isAllContentWritten
```
public boolean isAllContentWritten(long written)
```
  - isContentComplete
```
public boolean isContentComplete(long written)
```
  - closeOutput
```
public void closeOutput()
                 throws java.io.IOException
```
    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(org.eclipse.jetty.util.Callback callback)
```
  - getLongContentLength
```
public long getLongContentLength()
```
  - setLongContentLength
```
public void setLongContentLength(long len)
```
  - setContentLengthLong
```
public void setContentLengthLong(long length)
```
    Specified by:
    
    setContentLengthLong in interface jakarta.servlet.ServletResponse
  - setCharacterEncoding
```
public void setCharacterEncoding(java.lang.String encoding)
```
    Specified by:
    
    setCharacterEncoding in interface jakarta.servlet.ServletResponse
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
    Specified by:
    
    setContentType in interface jakarta.servlet.ServletResponse
  - setBufferSize
```
public void setBufferSize(int size)
```
    Specified by:
    
    setBufferSize in interface jakarta.servlet.ServletResponse
  - getBufferSize
```
public int getBufferSize()
```
    Specified by:
    
    getBufferSize in interface jakarta.servlet.ServletResponse
  - flushBuffer
```
public void flushBuffer()
                 throws java.io.IOException
```
    Specified by:
    
    flushBuffer in interface jakarta.servlet.ServletResponse
    
    Throws:
    
    java.io.IOException
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface jakarta.servlet.ServletResponse
  - resetContent
```
public void resetContent()
```
  - resetForForward
```
public void resetForForward()
```
  - resetBuffer
```
public void resetBuffer()
```
    Specified by:
    
    resetBuffer in interface jakarta.servlet.ServletResponse
  - getTrailers
```
public java.util.function.Supplier<org.eclipse.jetty.http.HttpFields> getTrailers()
```
  - setTrailers
```
public void setTrailers(java.util.function.Supplier<org.eclipse.jetty.http.HttpFields> trailers)
```
  - getTrailerFields
```
public java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> getTrailerFields()
```
    Specified by:
    
    getTrailerFields in interface jakarta.servlet.http.HttpServletResponse
  - setTrailerFields
```
public void setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> trailers)
```
    Specified by:
    
    setTrailerFields in interface jakarta.servlet.http.HttpServletResponse
  - newResponseMetaData
```
protected org.eclipse.jetty.http.MetaData.Response newResponseMetaData()
```
  - getCommittedMetaData
```
public org.eclipse.jetty.http.MetaData.Response getCommittedMetaData()
```
    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.
  - isCommitted
```
public boolean isCommitted()
```
    Specified by:
    
    isCommitted in interface jakarta.servlet.ServletResponse
  - setLocale
```
public void setLocale(java.util.Locale locale)
```
    Specified by:
    
    setLocale in interface jakarta.servlet.ServletResponse
  - getLocale
```
public java.util.Locale getLocale()
```
    Specified by:
    
    getLocale in interface jakarta.servlet.ServletResponse
  - getStatus
```
public int getStatus()
```
    Specified by:
    
    getStatus in interface jakarta.servlet.http.HttpServletResponse
  - getReason
```
public java.lang.String getReason()
```
  - getHttpFields
```
public org.eclipse.jetty.http.HttpFields.Mutable getHttpFields()
```
  - getContentCount
```
public long getContentCount()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - putHeaders
```
public void putHeaders(org.eclipse.jetty.http.HttpContent content,
                       long contentLength,
                       boolean etag)
```
  - putHeaders
```
public static void putHeaders(jakarta.servlet.http.HttpServletResponse response,
                              org.eclipse.jetty.http.HttpContent content,
                              long contentLength,
                              boolean etag)
```
  - unwrap
```
public static jakarta.servlet.http.HttpServletResponse unwrap(jakarta.servlet.ServletResponse servletResponse)
```

Class Response

Nested Class Summary

Field Summary

Fields inherited from interface jakarta.servlet.http.HttpServletResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_CONTENT_LENGTH

USE_KNOWN_CONTENT_LENGTH

SET_INCLUDE_HEADER_PREFIX

Constructor Detail

Response

Method Detail

getHttpChannel

recycle

getHttpOutput

reopen

errorClose

isIncluding

include

included

addCookie

addCookie

replaceCookie

containsHeader

encodeURL

encodeRedirectURL

encodeUrl

encodeRedirectUrl

sendError

sendError

sendProcessing

sendRedirect

sendRedirect

sendRedirect

sendRedirect

setDateHeader

addDateHeader

setHeader

setHeader

getHeaderNames

getHeader

getHeaders

addHeader

setIntHeader

addIntHeader

setStatus

setStatus

setStatusWithReason

getCharacterEncoding

getContentType

getOutputStream

isWriting

isStreaming

isWritingOrStreaming

getWriter

setContentLength

getContentLength

isAllContentWritten

isContentComplete

closeOutput

completeOutput

completeOutput

getLongContentLength

setLongContentLength

setContentLengthLong

setCharacterEncoding

setContentType

setBufferSize

getBufferSize

flushBuffer

reset

resetContent

resetForForward

resetBuffer

getTrailers

setTrailers

getTrailerFields

setTrailerFields