Response (Jetty :: Server Core 9.4.0.v20180619 API)

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

All Implemented Interfaces:

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Response.OutputType

Nested Classes
Modifier and Type	Class	Description
`static class`	`Response.OutputType`

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`HTTP_ONLY_COMMENT`	If this string is found within the comment of a cookie added with `addCookie(Cookie)`, then the cookie will be set as HTTP ONLY.
`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)`.

Fields inherited from interface javax.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)

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(javax.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`	`addSetCookie(java.lang.String name, java.lang.String value, java.lang.String domain, java.lang.String path, long maxAge, java.lang.String comment, boolean isSecure, boolean isHttpOnly, int version)`	Format a set cookie value
`void`	`closeOutput()`
`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`	`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`	`getHttpFields()`
`HttpOutput`	`getHttpOutput()`
`java.util.Locale`	`getLocale()`
`long`	`getLongContentLength()`
`javax.servlet.ServletOutputStream`	`getOutputStream()`
`java.lang.String`	`getReason()`
`int`	`getStatus()`
`java.io.PrintWriter`	`getWriter()`
`void`	`include()`
`void`	`included()`
`boolean`	`isAllContentWritten(long written)`
`boolean`	`isCommitted()`
`boolean`	`isContentComplete(long written)`
`boolean`	`isIncluding()`
`boolean`	`isWriting()`
`protected org.eclipse.jetty.http.MetaData.Response`	`newResponseMetaData()`
`static void`	`putHeaders(javax.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`	`reset()`
`void`	`reset(boolean preserveCookies)`
`void`	`resetBuffer()`
`void`	`resetForForward()`
`void`	`sendError(int sc)`
`void`	`sendError(int code, java.lang.String message)`
`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(java.lang.String location)`
`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 sm)`	Deprecated.
`void`	`setStatusWithReason(int sc, java.lang.String sm)`
`java.lang.String`	`toString()`

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

- Field Detail
  - 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
  - HTTP_ONLY_COMMENT
```
public static final java.lang.String HTTP_ONLY_COMMENT
```
    If this string is found within the comment of a cookie added with addCookie(Cookie), then the cookie will be set as HTTP ONLY.
    
    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()
```
  - 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(javax.servlet.http.Cookie cookie)
```
    Specified by:
    
    addCookie in interface javax.servlet.http.HttpServletResponse
  - addSetCookie
```
public void addSetCookie(java.lang.String name,
                         java.lang.String value,
                         java.lang.String domain,
                         java.lang.String path,
                         long maxAge,
                         java.lang.String comment,
                         boolean isSecure,
                         boolean isHttpOnly,
                         int version)
```
    Format a set cookie value
    
    Parameters:
    
    name - the name
    
    value - the value
    
    domain - the domain
    
    path - the path
    
    maxAge - the maximum age
    
    comment - the comment (only present on versions > 0)
    
    isSecure - true if secure cookie
    
    isHttpOnly - true if for http only
    
    version - version of cookie logic to use (0 == default behavior)
  - containsHeader
```
public boolean containsHeader(java.lang.String name)
```
    Specified by:
    
    containsHeader in interface javax.servlet.http.HttpServletResponse
  - encodeURL
```
public java.lang.String encodeURL(java.lang.String url)
```
    Specified by:
    
    encodeURL in interface javax.servlet.http.HttpServletResponse
  - encodeRedirectURL
```
public java.lang.String encodeRedirectURL(java.lang.String url)
```
    Specified by:
    
    encodeRedirectURL in interface javax.servlet.http.HttpServletResponse
  - encodeUrl
```
@Deprecated
public java.lang.String encodeUrl(java.lang.String url)
```
    Deprecated.
    
    Specified by:
    
    encodeUrl in interface javax.servlet.http.HttpServletResponse
  - encodeRedirectUrl
```
@Deprecated
public java.lang.String encodeRedirectUrl(java.lang.String url)
```
    Deprecated.
    
    Specified by:
    
    encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse
  - sendError
```
public void sendError(int sc)
               throws java.io.IOException
```
    Specified by:
    
    sendError in interface javax.servlet.http.HttpServletResponse
    
    Throws:
    
    java.io.IOException
  - sendError
```
public void sendError(int code,
                      java.lang.String message)
               throws java.io.IOException
```
    Specified by:
    
    sendError in interface javax.servlet.http.HttpServletResponse
    
    Throws:
    
    java.io.IOException
  - sendProcessing
```
public void sendProcessing()
                    throws java.io.IOException
```
    Sends a 102-Processing response. If the connection is a 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)
                  throws java.io.IOException
```
    Specified by:
    
    sendRedirect in interface javax.servlet.http.HttpServletResponse
    
    Throws:
    
    java.io.IOException
  - setDateHeader
```
public void setDateHeader(java.lang.String name,
                          long date)
```
    Specified by:
    
    setDateHeader in interface javax.servlet.http.HttpServletResponse
  - addDateHeader
```
public void addDateHeader(java.lang.String name,
                          long date)
```
    Specified by:
    
    addDateHeader in interface javax.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 javax.servlet.http.HttpServletResponse
  - getHeaderNames
```
public java.util.Collection<java.lang.String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletResponse
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletResponse
  - getHeaders
```
public java.util.Collection<java.lang.String> getHeaders(java.lang.String name)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletResponse
  - addHeader
```
public void addHeader(java.lang.String name,
                      java.lang.String value)
```
    Specified by:
    
    addHeader in interface javax.servlet.http.HttpServletResponse
  - setIntHeader
```
public void setIntHeader(java.lang.String name,
                         int value)
```
    Specified by:
    
    setIntHeader in interface javax.servlet.http.HttpServletResponse
  - addIntHeader
```
public void addIntHeader(java.lang.String name,
                         int value)
```
    Specified by:
    
    addIntHeader in interface javax.servlet.http.HttpServletResponse
  - setStatus
```
public void setStatus(int sc)
```
    Specified by:
    
    setStatus in interface javax.servlet.http.HttpServletResponse
  - setStatus
```
@Deprecated
public void setStatus(int sc,
                      java.lang.String sm)
```
    Deprecated.
    
    Specified by:
    
    setStatus in interface javax.servlet.http.HttpServletResponse
  - setStatusWithReason
```
public void setStatusWithReason(int sc,
                                java.lang.String sm)
```
  - getCharacterEncoding
```
public java.lang.String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletResponse
  - getContentType
```
public java.lang.String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletResponse
  - getOutputStream
```
public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException
```
    Specified by:
    
    getOutputStream in interface javax.servlet.ServletResponse
    
    Throws:
    
    java.io.IOException
  - isWriting
```
public boolean isWriting()
```
  - getWriter
```
public java.io.PrintWriter getWriter()
                              throws java.io.IOException
```
    Specified by:
    
    getWriter in interface javax.servlet.ServletResponse
    
    Throws:
    
    java.io.IOException
  - setContentLength
```
public void setContentLength(int len)
```
    Specified by:
    
    setContentLength in interface javax.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
  - getLongContentLength
```
public long getLongContentLength()
```
  - setLongContentLength
```
public void setLongContentLength(long len)
```
  - setContentLengthLong
```
public void setContentLengthLong(long length)
```
    Specified by:
    
    setContentLengthLong in interface javax.servlet.ServletResponse
  - setCharacterEncoding
```
public void setCharacterEncoding(java.lang.String encoding)
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletResponse
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
    Specified by:
    
    setContentType in interface javax.servlet.ServletResponse
  - setBufferSize
```
public void setBufferSize(int size)
```
    Specified by:
    
    setBufferSize in interface javax.servlet.ServletResponse
  - getBufferSize
```
public int getBufferSize()
```
    Specified by:
    
    getBufferSize in interface javax.servlet.ServletResponse
  - flushBuffer
```
public void flushBuffer()
                 throws java.io.IOException
```
    Specified by:
    
    flushBuffer in interface javax.servlet.ServletResponse
    
    Throws:
    
    java.io.IOException
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface javax.servlet.ServletResponse
  - reset
```
public void reset(boolean preserveCookies)
```
  - resetForForward
```
public void resetForForward()
```
  - resetBuffer
```
public void resetBuffer()
```
    Specified by:
    
    resetBuffer in interface javax.servlet.ServletResponse
  - 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 javax.servlet.ServletResponse
  - setLocale
```
public void setLocale(java.util.Locale locale)
```
    Specified by:
    
    setLocale in interface javax.servlet.ServletResponse
  - getLocale
```
public java.util.Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletResponse
  - getStatus
```
public int getStatus()
```
    Specified by:
    
    getStatus in interface javax.servlet.http.HttpServletResponse
  - getReason
```
public java.lang.String getReason()
```
  - getHttpFields
```
public org.eclipse.jetty.http.HttpFields 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(javax.servlet.http.HttpServletResponse response,
                              org.eclipse.jetty.http.HttpContent content,
                              long contentLength,
                              boolean etag)
```

Class Response

Nested Class Summary

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SET_INCLUDE_HEADER_PREFIX

HTTP_ONLY_COMMENT

Constructor Detail

Response

Method Detail

getHttpChannel

recycle

getHttpOutput

isIncluding

include

included

addCookie

addCookie

addSetCookie

containsHeader

encodeURL

encodeRedirectURL

encodeUrl

encodeRedirectUrl

sendError

sendError

sendProcessing

sendRedirect

sendRedirect

setDateHeader

addDateHeader

setHeader

setHeader

getHeaderNames

getHeader

getHeaders

addHeader

setIntHeader

addIntHeader

setStatus

setStatus

setStatusWithReason

getCharacterEncoding

getContentType

getOutputStream

isWriting

getWriter

setContentLength

getContentLength

isAllContentWritten

isContentComplete

closeOutput

getLongContentLength

setLongContentLength

setContentLengthLong

setCharacterEncoding

setContentType

setBufferSize

getBufferSize

flushBuffer

reset

reset

resetForForward

resetBuffer

newResponseMetaData

getCommittedMetaData

isCommitted

setLocale

getLocale

getStatus

getReason

getHttpFields

getContentCount

toString

putHeaders

putHeaders