Response (The Adobe Experience Manager SDK 2020.7.3902.20200716T022312Z-200604)

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

All Implemented Interfaces:

HttpServletResponse, ServletResponse
```
public class Response
extends Object
implements HttpServletResponse
```
Response provides the implementation for HttpServletResponse.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Response.OutputType

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

Field Summary

Fields
Modifier and Type	Field and Description
`static 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 and Description

Response(HttpChannel channel, HttpOutput out)

Constructors
Constructor and Description
`Response(HttpChannel channel, HttpOutput out)`

Method Summary

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

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

- Field Detail
  - SET_INCLUDE_HEADER_PREFIX
```
public static final 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()
```
  - 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(HttpCookie cookie)
```
  - replaceCookie
```
public void replaceCookie(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
  - addCookie
```
public void addCookie(Cookie cookie)
```
    Specified by:
    
    addCookie in interface HttpServletResponse
  - containsHeader
```
public boolean containsHeader(String name)
```
    Specified by:
    
    containsHeader in interface HttpServletResponse
  - encodeURL
```
public String encodeURL(String url)
```
    Specified by:
    
    encodeURL in interface HttpServletResponse
  - encodeRedirectURL
```
public String encodeRedirectURL(String url)
```
    Specified by:
    
    encodeRedirectURL in interface HttpServletResponse
  - encodeUrl
```
@Deprecated
public String encodeUrl(String url)
```
    Deprecated.
    
    Specified by:
    
    encodeUrl in interface HttpServletResponse
  - encodeRedirectUrl
```
@Deprecated
public String encodeRedirectUrl(String url)
```
    Deprecated.
    
    Specified by:
    
    encodeRedirectUrl in interface HttpServletResponse
  - sendError
```
public void sendError(int sc)
               throws IOException
```
    Specified by:
    
    sendError in interface HttpServletResponse
    
    Throws:
    
    IOException
  - sendError
```
public void sendError(int code,
                      String message)
               throws 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 HttpServletResponse
    
    Parameters:
    
    code - The error code
    
    message - The message
    
    Throws:
    
    IOException - If an IO problem occurred sending the error response.
  - sendProcessing
```
public void sendProcessing()
                    throws 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:
    
    IOException - if unable to send the 102 response
    
    See Also:
    
    HttpServletResponse.sendError(int)
  - sendRedirect
```
public void sendRedirect(int code,
                         String location)
                  throws 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:
    
    IOException - if unable to send the redirect
  - sendRedirect
```
public void sendRedirect(String location)
                  throws IOException
```
    Specified by:
    
    sendRedirect in interface HttpServletResponse
    
    Throws:
    
    IOException
  - setDateHeader
```
public void setDateHeader(String name,
                          long date)
```
    Specified by:
    
    setDateHeader in interface HttpServletResponse
  - addDateHeader
```
public void addDateHeader(String name,
                          long date)
```
    Specified by:
    
    addDateHeader in interface HttpServletResponse
  - setHeader
```
public void setHeader(HttpHeader name,
                      String value)
```
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Specified by:
    
    setHeader in interface HttpServletResponse
  - getHeaderNames
```
public Collection<String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface HttpServletResponse
  - getHeader
```
public String getHeader(String name)
```
    Specified by:
    
    getHeader in interface HttpServletResponse
  - getHeaders
```
public Collection<String> getHeaders(String name)
```
    Specified by:
    
    getHeaders in interface HttpServletResponse
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Specified by:
    
    addHeader in interface HttpServletResponse
  - setIntHeader
```
public void setIntHeader(String name,
                         int value)
```
    Specified by:
    
    setIntHeader in interface HttpServletResponse
  - addIntHeader
```
public void addIntHeader(String name,
                         int value)
```
    Specified by:
    
    addIntHeader in interface HttpServletResponse
  - setStatus
```
public void setStatus(int sc)
```
    Specified by:
    
    setStatus in interface HttpServletResponse
  - setStatus
```
@Deprecated
public void setStatus(int sc,
                                  String sm)
```
    Deprecated.
    
    Specified by:
    
    setStatus in interface HttpServletResponse
  - setStatusWithReason
```
public void setStatusWithReason(int sc,
                                String sm)
```
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface ServletResponse
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface ServletResponse
  - getOutputStream
```
public ServletOutputStream getOutputStream()
                                    throws IOException
```
    Specified by:
    
    getOutputStream in interface ServletResponse
    
    Throws:
    
    IOException
  - isWriting
```
public boolean isWriting()
```
  - isStreaming
```
public boolean isStreaming()
```
  - isWritingOrStreaming
```
public boolean isWritingOrStreaming()
```
  - getWriter
```
public PrintWriter getWriter()
                      throws IOException
```
    Specified by:
    
    getWriter in interface ServletResponse
    
    Throws:
    
    IOException
  - setContentLength
```
public void setContentLength(int len)
```
    Specified by:
    
    setContentLength in interface ServletResponse
  - getContentLength
```
public long getContentLength()
```
  - isAllContentWritten
```
public boolean isAllContentWritten(long written)
```
  - isContentComplete
```
public boolean isContentComplete(long written)
```
  - closeOutput
```
public void closeOutput()
                 throws IOException
```
    Throws:
    
    IOException
  - completeOutput
```
@Deprecated
public void completeOutput()
                                throws IOException
```
    Deprecated. Use closeOutput()
    
    close the output
    
    Throws:
    
    IOException
  - completeOutput
```
public void completeOutput(Callback callback)
```
  - getLongContentLength
```
public long getLongContentLength()
```
  - setLongContentLength
```
public void setLongContentLength(long len)
```
  - setContentLengthLong
```
public void setContentLengthLong(long length)
```
    Specified by:
    
    setContentLengthLong in interface ServletResponse
  - setCharacterEncoding
```
public void setCharacterEncoding(String encoding)
```
    Specified by:
    
    setCharacterEncoding in interface ServletResponse
  - setContentType
```
public void setContentType(String contentType)
```
    Specified by:
    
    setContentType in interface ServletResponse
  - setBufferSize
```
public void setBufferSize(int size)
```
    Specified by:
    
    setBufferSize in interface ServletResponse
  - getBufferSize
```
public int getBufferSize()
```
    Specified by:
    
    getBufferSize in interface ServletResponse
  - flushBuffer
```
public void flushBuffer()
                 throws IOException
```
    Specified by:
    
    flushBuffer in interface ServletResponse
    
    Throws:
    
    IOException
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface ServletResponse
  - resetContent
```
public void resetContent()
```
  - resetForForward
```
public void resetForForward()
```
  - resetBuffer
```
public void resetBuffer()
```
    Specified by:
    
    resetBuffer in interface ServletResponse
  - setTrailers
```
public void setTrailers(Supplier<HttpFields> trailers)
```
  - getTrailers
```
public Supplier<HttpFields> getTrailers()
```
  - getCommittedMetaData
```
public 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 ServletResponse
  - setLocale
```
public void setLocale(Locale locale)
```
    Specified by:
    
    setLocale in interface ServletResponse
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface ServletResponse
  - getStatus
```
public int getStatus()
```
    Specified by:
    
    getStatus in interface HttpServletResponse
  - getReason
```
public String getReason()
```
  - getHttpFields
```
public HttpFields getHttpFields()
```
  - getContentCount
```
public long getContentCount()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - putHeaders
```
public void putHeaders(HttpContent content,
                       long contentLength,
                       boolean etag)
```
  - putHeaders
```
public static void putHeaders(HttpServletResponse response,
                              HttpContent content,
                              long contentLength,
                              boolean etag)
```
  - unwrap
```
public static HttpServletResponse unwrap(ServletResponse servletResponse)
```

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

Constructor Detail

Response

Method Detail

getHttpChannel

getHttpOutput

reopen

errorClose

isIncluding

include

included

addCookie

replaceCookie

addCookie

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

isStreaming

isWritingOrStreaming

getWriter

setContentLength

getContentLength

isAllContentWritten

isContentComplete

closeOutput

completeOutput

completeOutput

getLongContentLength

setLongContentLength

setContentLengthLong

setCharacterEncoding

setContentType

setBufferSize

getBufferSize

flushBuffer

reset

resetContent

resetForForward

resetBuffer

setTrailers

getTrailers

getCommittedMetaData

isCommitted

setLocale

getLocale

getStatus

getReason

getHttpFields