java.lang.Object
- org.apache.catalina.connector.ResponseFacade

All Implemented Interfaces:

jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse
```
public class ResponseFacade
extends Object
implements jakarta.servlet.http.HttpServletResponse
```
Facade class that wraps a Coyote response object. All methods are delegated to the wrapped response.

Version:

$Revision: 1.9 $ $Date: 2007/05/05 05:32:43 $

Author:

Remy Maucherat, Jean-Francois Arcand

Field Summary

Fields
Modifier and Type Field Description

protected Response response
The wrapped response.
- 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

ResponseFacade(Response response)
Construct a wrapper for the specified response.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addCookie(jakarta.servlet.http.Cookie cookie)`
`void`	`addDateHeader(String name, long date)`
`void`	`addHeader(String name, String value)`
`void`	`addIntHeader(String name, int value)`
`void`	`clear()`	Clear facade.
`protected Object`	`clone()`	Prevent cloning the facade.
`boolean`	`containsHeader(String name)`
`String`	`encodeRedirectURL(String url)`
`String`	`encodeURL(String url)`
`void`	`finish()`
`void`	`flushBuffer()`
`int`	`getBufferSize()`
`String`	`getCharacterEncoding()`
`String`	`getContentType()`
`String`	`getHeader(String name)`
`Collection<String>`	`getHeaderNames()`
`Collection<String>`	`getHeaders(String name)`
`Locale`	`getLocale()`
`jakarta.servlet.ServletOutputStream`	`getOutputStream()`
`int`	`getStatus()`
`Supplier<Map<String,String>>`	`getTrailerFields()`
`PrintWriter`	`getWriter()`
`boolean`	`isCommitted()`
`boolean`	`isFinished()`
`void`	`reset()`
`void`	`resetBuffer()`
`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(String name, String value)`
`void`	`setIntHeader(String name, int value)`
`void`	`setLocale(Locale loc)`
`void`	`setStatus(int sc)`
`void`	`setTrailerFields(Supplier<Map<String,String>> supplier)`

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

- Field Detail
  - response
```
protected Response response
```
    The wrapped response.
- Constructor Detail
  - ResponseFacade
```
public ResponseFacade(Response response)
```
    Construct a wrapper for the specified response.
    
    Parameters:
    
    response - The response to be wrapped
- Method Detail
  - clone
```
protected Object clone()
                throws CloneNotSupportedException
```
    Prevent cloning the facade.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    never
    
    Throws:
    
    CloneNotSupportedException - always
  - clear
```
public void clear()
```
    Clear facade.
  - finish
```
public void finish()
```
  - isFinished
```
public boolean isFinished()
```
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface jakarta.servlet.ServletResponse
  - getOutputStream
```
public jakarta.servlet.ServletOutputStream getOutputStream()
                                                    throws IOException
```
    Specified by:
    
    getOutputStream in interface jakarta.servlet.ServletResponse
    
    Throws:
    
    IOException
  - getWriter
```
public PrintWriter getWriter()
                      throws IOException
```
    Specified by:
    
    getWriter in interface jakarta.servlet.ServletResponse
    
    Throws:
    
    IOException
  - 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
  - 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
  - addCookie
```
public void addCookie(jakarta.servlet.http.Cookie cookie)
```
    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
  - 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
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Specified by:
    
    addHeader in interface jakarta.servlet.http.HttpServletResponse
  - 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
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface jakarta.servlet.ServletResponse
  - setCharacterEncoding
```
public void setCharacterEncoding(String charSet)
```
    Specified by:
    
    setCharacterEncoding in interface jakarta.servlet.ServletResponse
  - 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
  - getTrailerFields
```
public Supplier<Map<String,String>> getTrailerFields()
```
    Specified by:
    
    getTrailerFields in interface jakarta.servlet.http.HttpServletResponse
  - setTrailerFields
```
public void setTrailerFields(Supplier<Map<String,String>> supplier)
```
    Specified by:
    
    setTrailerFields in interface jakarta.servlet.http.HttpServletResponse

Class ResponseFacade

Field Summary

Fields inherited from interface jakarta.servlet.http.HttpServletResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

response

Constructor Detail

ResponseFacade

Method Detail

clone

clear

finish

isFinished

getCharacterEncoding

getOutputStream

getWriter

setContentLength

setContentLengthLong

setContentType

setBufferSize

getBufferSize

flushBuffer

resetBuffer

isCommitted

reset

setLocale

getLocale

addCookie

containsHeader

encodeURL

encodeRedirectURL

sendError

sendError

sendRedirect

setDateHeader

addDateHeader

setHeader

addHeader

setIntHeader

addIntHeader

setStatus

getContentType

setCharacterEncoding

getStatus

getHeader

getHeaders

getHeaderNames

getTrailerFields

setTrailerFields