HttpServletResponseImpl (Undertow Servlet - Jakarta Variant 2.2.19.Final API)

java.lang.Object
- io.undertow.servlet.spec.HttpServletResponseImpl

All Implemented Interfaces:

jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse
```
public final class HttpServletResponseImpl
extends Object
implements jakarta.servlet.http.HttpServletResponse
```
Author:

Stuart Douglas, Richard Opalka

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HttpServletResponseImpl.ResponseState

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpServletResponseImpl.ResponseState`

Field Summary
- 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 and Description

HttpServletResponseImpl(HttpServerExchange exchange, ServletContextImpl servletContext)

Constructors
Constructor and Description
`HttpServletResponseImpl(HttpServerExchange exchange, ServletContextImpl servletContext)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCookie(jakarta.servlet.http.Cookie newCookie)`
`void`	`addDateHeader(String name, long date)`
`void`	`addHeader(HttpString name, String value)`
`void`	`addHeader(String name, String value)`
`void`	`addIntHeader(String name, int value)`
`void`	`closeStreamAndWriter()`
`boolean`	`containsHeader(String name)`
`void`	`doErrorDispatch(int sc, String error)`
`String`	`encodeRedirectUrl(String url)`
`String`	`encodeRedirectURL(String url)` Encode the session identifier associated with this response into the specified redirect URL, if necessary.
`String`	`encodeUrl(String url)`
`String`	`encodeURL(String url)`
`void`	`flushBuffer()`
`void`	`freeResources()`
`int`	`getBufferSize()`
`String`	`getCharacterEncoding()`
`long`	`getContentLength()`
`String`	`getContentType()`
`HttpServerExchange`	`getExchange()`
`String`	`getHeader(String name)`
`Collection<String>`	`getHeaderNames()`
`Collection<String>`	`getHeaders(String name)`
`Locale`	`getLocale()`
`jakarta.servlet.ServletOutputStream`	`getOutputStream()`
`ServletContextImpl`	`getServletContext()`
`int`	`getStatus()`
`Supplier<Map<String,String>>`	`getTrailerFields()`
`PrintWriter`	`getWriter()`
`boolean`	`isCommitted()`
`boolean`	`isInsideInclude()`
`boolean`	`isTreatAsCommitted()`
`void`	`reset()`
`void`	`resetBuffer()`
`void`	`responseDone()`
`void`	`sendError(int sc)`
`void`	`sendError(int sc, String msg)`
`void`	`sendRedirect(String location)`
`void`	`setBufferSize(int size)`
`void`	`setCharacterEncoding(String charset)`
`void`	`setContentLength(int len)`
`void`	`setContentLengthLong(long len)`
`void`	`setContentType(String type)`
`void`	`setDateHeader(String name, long date)`
`void`	`setHeader(HttpString name, String value)`
`void`	`setHeader(String name, String value)`
`void`	`setInsideInclude(boolean insideInclude)`
`void`	`setIntHeader(String name, int value)`
`void`	`setLocale(Locale loc)`
`void`	`setServletContext(ServletContextImpl servletContext)`
`void`	`setStatus(int sc)`
`void`	`setStatus(int sc, String sm)`
`void`	`setTrailerFields(Supplier<Map<String,String>> supplier)`

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

- Constructor Detail
  - HttpServletResponseImpl
```
public HttpServletResponseImpl(HttpServerExchange exchange,
                               ServletContextImpl servletContext)
```
- Method Detail
  - getExchange
```
public HttpServerExchange getExchange()
```
  - addCookie
```
public void addCookie(jakarta.servlet.http.Cookie newCookie)
```
    Specified by:
    
    addCookie in interface jakarta.servlet.http.HttpServletResponse
  - containsHeader
```
public boolean containsHeader(String name)
```
    Specified by:
    
    containsHeader in interface jakarta.servlet.http.HttpServletResponse
  - encodeUrl
```
public String encodeUrl(String url)
```
    Specified by:
    
    encodeUrl in interface jakarta.servlet.http.HttpServletResponse
  - encodeRedirectUrl
```
public String encodeRedirectUrl(String url)
```
    Specified by:
    
    encodeRedirectUrl in interface jakarta.servlet.http.HttpServletResponse
  - sendError
```
public void sendError(int sc,
                      String msg)
               throws IOException
```
    Specified by:
    
    sendError in interface jakarta.servlet.http.HttpServletResponse
    
    Throws:
    
    IOException
  - doErrorDispatch
```
public void doErrorDispatch(int sc,
                            String error)
                     throws IOException
```
    Throws:
    
    IOException
  - sendError
```
public void sendError(int sc)
               throws IOException
```
    Specified by:
    
    sendError in interface jakarta.servlet.http.HttpServletResponse
    
    Throws:
    
    IOException
  - sendRedirect
```
public void sendRedirect(String location)
                  throws IOException
```
    Specified by:
    
    sendRedirect in interface jakarta.servlet.http.HttpServletResponse
    
    Throws:
    
    IOException
  - setDateHeader
```
public void setDateHeader(String name,
                          long date)
```
    Specified by:
    
    setDateHeader in interface jakarta.servlet.http.HttpServletResponse
  - addDateHeader
```
public void addDateHeader(String name,
                          long date)
```
    Specified by:
    
    addDateHeader in interface jakarta.servlet.http.HttpServletResponse
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Specified by:
    
    setHeader in interface jakarta.servlet.http.HttpServletResponse
  - setHeader
```
public void setHeader(HttpString name,
                      String value)
```
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Specified by:
    
    addHeader in interface jakarta.servlet.http.HttpServletResponse
  - addHeader
```
public void addHeader(HttpString name,
                      String value)
```
  - setIntHeader
```
public void setIntHeader(String name,
                         int value)
```
    Specified by:
    
    setIntHeader in interface jakarta.servlet.http.HttpServletResponse
  - addIntHeader
```
public void addIntHeader(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
```
public void setStatus(int sc,
                      String sm)
```
    Specified by:
    
    setStatus in interface jakarta.servlet.http.HttpServletResponse
  - getStatus
```
public int getStatus()
```
    Specified by:
    
    getStatus in interface jakarta.servlet.http.HttpServletResponse
  - getHeader
```
public String getHeader(String name)
```
    Specified by:
    
    getHeader in interface jakarta.servlet.http.HttpServletResponse
  - getHeaders
```
public Collection<String> getHeaders(String name)
```
    Specified by:
    
    getHeaders in interface jakarta.servlet.http.HttpServletResponse
  - getHeaderNames
```
public Collection<String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface jakarta.servlet.http.HttpServletResponse
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface jakarta.servlet.ServletResponse
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface jakarta.servlet.ServletResponse
  - getOutputStream
```
public jakarta.servlet.ServletOutputStream getOutputStream()
```
    Specified by:
    
    getOutputStream in interface jakarta.servlet.ServletResponse
  - getWriter
```
public PrintWriter getWriter()
                      throws IOException
```
    Specified by:
    
    getWriter in interface jakarta.servlet.ServletResponse
    
    Throws:
    
    IOException
  - setCharacterEncoding
```
public void setCharacterEncoding(String charset)
```
    Specified by:
    
    setCharacterEncoding in interface jakarta.servlet.ServletResponse
  - setContentLength
```
public void setContentLength(int len)
```
    Specified by:
    
    setContentLength in interface jakarta.servlet.ServletResponse
  - setContentLengthLong
```
public void setContentLengthLong(long len)
```
    Specified by:
    
    setContentLengthLong in interface jakarta.servlet.ServletResponse
  - setContentType
```
public void setContentType(String type)
```
    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 IOException
```
    Specified by:
    
    flushBuffer in interface jakarta.servlet.ServletResponse
    
    Throws:
    
    IOException
  - closeStreamAndWriter
```
public void closeStreamAndWriter()
                          throws IOException
```
    Throws:
    
    IOException
  - freeResources
```
public void freeResources()
                   throws IOException
```
    Throws:
    
    IOException
  - resetBuffer
```
public void resetBuffer()
```
    Specified by:
    
    resetBuffer in interface jakarta.servlet.ServletResponse
  - isCommitted
```
public boolean isCommitted()
```
    Specified by:
    
    isCommitted in interface jakarta.servlet.ServletResponse
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface jakarta.servlet.ServletResponse
  - setLocale
```
public void setLocale(Locale loc)
```
    Specified by:
    
    setLocale in interface jakarta.servlet.ServletResponse
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface jakarta.servlet.ServletResponse
  - responseDone
```
public void responseDone()
```
  - isInsideInclude
```
public boolean isInsideInclude()
```
  - setInsideInclude
```
public void setInsideInclude(boolean insideInclude)
```
  - setServletContext
```
public void setServletContext(ServletContextImpl servletContext)
```
  - getServletContext
```
public ServletContextImpl getServletContext()
```
  - encodeURL
```
public String encodeURL(String url)
```
    Specified by:
    
    encodeURL in interface jakarta.servlet.http.HttpServletResponse
  - encodeRedirectURL
```
public String encodeRedirectURL(String url)
```
    Encode the session identifier associated with this response into the specified redirect URL, if necessary.
    
    Specified by:
    
    encodeRedirectURL in interface jakarta.servlet.http.HttpServletResponse
    
    Parameters:
    
    url - URL to be encoded
  - getContentLength
```
public long getContentLength()
```
  - isTreatAsCommitted
```
public boolean isTreatAsCommitted()
```
  - setTrailerFields
```
public void setTrailerFields(Supplier<Map<String,String>> supplier)
```
    Specified by:
    
    setTrailerFields in interface jakarta.servlet.http.HttpServletResponse
  - getTrailerFields
```
public Supplier<Map<String,String>> getTrailerFields()
```
    Specified by:
    
    getTrailerFields in interface jakarta.servlet.http.HttpServletResponse

Class HttpServletResponseImpl

Nested Class Summary

Field Summary

Fields inherited from interface jakarta.servlet.http.HttpServletResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpServletResponseImpl

Method Detail

getExchange

addCookie

containsHeader

encodeUrl

encodeRedirectUrl

sendError

doErrorDispatch

sendError

sendRedirect

setDateHeader

addDateHeader

setHeader

setHeader

addHeader

addHeader

setIntHeader

addIntHeader

setStatus

setStatus

getStatus

getHeader

getHeaders

getHeaderNames

getCharacterEncoding

getContentType

getOutputStream

getWriter

setCharacterEncoding

setContentLength

setContentLengthLong

setContentType

setBufferSize

getBufferSize

flushBuffer

closeStreamAndWriter

freeResources

resetBuffer

isCommitted

reset

setLocale

getLocale

responseDone

isInsideInclude

setInsideInclude

setServletContext

getServletContext

encodeURL

encodeRedirectURL

getContentLength

isTreatAsCommitted

setTrailerFields

getTrailerFields