ResteasyHttpServletResponseWrapper (RESTEasy JAX-RS 3.0.10.Final API)

java.lang.Object
- javax.servlet.ServletResponseWrapper
- - org.jboss.resteasy.core.ResteasyHttpServletResponseWrapper

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
```
public class ResteasyHttpServletResponseWrapper
extends javax.servlet.ServletResponseWrapper
implements javax.servlet.http.HttpServletResponse
```
ResteasyHttpServletResponseWrapper is introduced to support the use of RequestDispatcher.forward() and RequestDispatcher.include(), which need to be able to retrieve the orginal HttpServletResponse.

Version:

$Revision: 1.1 $ Copyright Apr 18, 2014

Author:

Ron Sigal

Field Summary
- 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
`ResteasyHttpServletResponseWrapper(javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletResponse proxy)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCookie(javax.servlet.http.Cookie cookie)`
`void`	`addDateHeader(String name, long date)`
`void`	`addHeader(String name, String value)`
`void`	`addIntHeader(String name, int value)`
`boolean`	`containsHeader(String name)`
`String`	`encodeRedirectUrl(String url)` Deprecated. As of version 2.1, use encodeRedirectURL(String url) instead
`String`	`encodeRedirectURL(String url)`
`String`	`encodeUrl(String url)` Deprecated. As of version 2.1, use encodeURL(String url) instead
`String`	`encodeURL(String url)`
`void`	`flushBuffer()`
`int`	`getBufferSize()`
`String`	`getCharacterEncoding()`
`String`	`getContentType()`
`javax.servlet.http.HttpServletResponse`	`getHttpServletResponse()`
`Locale`	`getLocale()`
`javax.servlet.ServletOutputStream`	`getOutputStream()`
`javax.servlet.ServletResponse`	`getResponse()`
`PrintWriter`	`getWriter()`
`boolean`	`isCommitted()`
`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`	`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`	`setStatus(int sc, String sm)` Deprecated. As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use `setStatus(int)`, to send an error with a description use `sendError(int, String)`. Sets the status code and message for this response.

Methods inherited from class javax.servlet.ServletResponseWrapper
isWrapperFor, isWrapperFor, setContentLengthLong, setResponse

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

Methods inherited from interface javax.servlet.http.HttpServletResponse
getHeader, getHeaderNames, getHeaders, getStatus

Methods inherited from interface javax.servlet.ServletResponse
setContentLengthLong

- Constructor Detail
  - ResteasyHttpServletResponseWrapper
```
public ResteasyHttpServletResponseWrapper(javax.servlet.http.HttpServletResponse response,
                                  javax.servlet.http.HttpServletResponse proxy)
```
- Method Detail
  - getHttpServletResponse
```
public javax.servlet.http.HttpServletResponse getHttpServletResponse()
```
  - getResponse
```
public javax.servlet.ServletResponse getResponse()
```
    Overrides:
    
    getResponse in class javax.servlet.ServletResponseWrapper
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletResponse
    
    Overrides:
    
    getCharacterEncoding in class javax.servlet.ServletResponseWrapper
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletResponse
    
    Overrides:
    
    getContentType in class javax.servlet.ServletResponseWrapper
  - getOutputStream
```
public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException
```
    Specified by:
    
    getOutputStream in interface javax.servlet.ServletResponse
    
    Overrides:
    
    getOutputStream in class javax.servlet.ServletResponseWrapper
    
    Throws:
    
    IOException
  - getWriter
```
public PrintWriter getWriter()
                      throws IOException
```
    Specified by:
    
    getWriter in interface javax.servlet.ServletResponse
    
    Overrides:
    
    getWriter in class javax.servlet.ServletResponseWrapper
    
    Throws:
    
    IOException
  - setCharacterEncoding
```
public void setCharacterEncoding(String charset)
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletResponse
    
    Overrides:
    
    setCharacterEncoding in class javax.servlet.ServletResponseWrapper
  - setContentLength
```
public void setContentLength(int len)
```
    Specified by:
    
    setContentLength in interface javax.servlet.ServletResponse
    
    Overrides:
    
    setContentLength in class javax.servlet.ServletResponseWrapper
  - setContentType
```
public void setContentType(String type)
```
    Specified by:
    
    setContentType in interface javax.servlet.ServletResponse
    
    Overrides:
    
    setContentType in class javax.servlet.ServletResponseWrapper
  - setBufferSize
```
public void setBufferSize(int size)
```
    Specified by:
    
    setBufferSize in interface javax.servlet.ServletResponse
    
    Overrides:
    
    setBufferSize in class javax.servlet.ServletResponseWrapper
  - getBufferSize
```
public int getBufferSize()
```
    Specified by:
    
    getBufferSize in interface javax.servlet.ServletResponse
    
    Overrides:
    
    getBufferSize in class javax.servlet.ServletResponseWrapper
  - flushBuffer
```
public void flushBuffer()
                 throws IOException
```
    Specified by:
    
    flushBuffer in interface javax.servlet.ServletResponse
    
    Overrides:
    
    flushBuffer in class javax.servlet.ServletResponseWrapper
    
    Throws:
    
    IOException
  - resetBuffer
```
public void resetBuffer()
```
    Specified by:
    
    resetBuffer in interface javax.servlet.ServletResponse
    
    Overrides:
    
    resetBuffer in class javax.servlet.ServletResponseWrapper
  - isCommitted
```
public boolean isCommitted()
```
    Specified by:
    
    isCommitted in interface javax.servlet.ServletResponse
    
    Overrides:
    
    isCommitted in class javax.servlet.ServletResponseWrapper
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface javax.servlet.ServletResponse
    
    Overrides:
    
    reset in class javax.servlet.ServletResponseWrapper
  - setLocale
```
public void setLocale(Locale loc)
```
    Specified by:
    
    setLocale in interface javax.servlet.ServletResponse
    
    Overrides:
    
    setLocale in class javax.servlet.ServletResponseWrapper
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletResponse
    
    Overrides:
    
    getLocale in class javax.servlet.ServletResponseWrapper
  - addCookie
```
public void addCookie(javax.servlet.http.Cookie cookie)
```
    Specified by:
    
    addCookie in interface javax.servlet.http.HttpServletResponse
  - containsHeader
```
public boolean containsHeader(String name)
```
    Specified by:
    
    containsHeader in interface javax.servlet.http.HttpServletResponse
  - encodeURL
```
public String encodeURL(String url)
```
    Specified by:
    
    encodeURL in interface javax.servlet.http.HttpServletResponse
  - encodeRedirectURL
```
public String encodeRedirectURL(String url)
```
    Specified by:
    
    encodeRedirectURL in interface javax.servlet.http.HttpServletResponse
  - encodeUrl
```
public String encodeUrl(String url)
```
    Deprecated. As of version 2.1, use encodeURL(String url) instead
    
    Specified by:
    
    encodeUrl in interface javax.servlet.http.HttpServletResponse
    
    Parameters:
    url - the url to be encoded.
    
    Returns:
    the encoded URL if encoding is needed; the unchanged URL otherwise.
  - encodeRedirectUrl
```
public String encodeRedirectUrl(String url)
```
    Deprecated. As of version 2.1, use encodeRedirectURL(String url) instead
    
    Specified by:
    
    encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse
    
    Parameters:
    url - the url to be encoded.
    
    Returns:
    the encoded URL if encoding is needed; the unchanged URL otherwise.
  - sendError
```
public void sendError(int sc,
             String msg)
               throws IOException
```
    Specified by:
    
    sendError in interface javax.servlet.http.HttpServletResponse
    
    Throws:
    
    IOException
  - sendError
```
public void sendError(int sc)
               throws IOException
```
    Specified by:
    
    sendError in interface javax.servlet.http.HttpServletResponse
    
    Throws:
    
    IOException
  - sendRedirect
```
public void sendRedirect(String location)
                  throws IOException
```
    Specified by:
    
    sendRedirect in interface javax.servlet.http.HttpServletResponse
    
    Throws:
    
    IOException
  - setDateHeader
```
public void setDateHeader(String name,
                 long date)
```
    Specified by:
    
    setDateHeader in interface javax.servlet.http.HttpServletResponse
  - addDateHeader
```
public void addDateHeader(String name,
                 long date)
```
    Specified by:
    
    addDateHeader in interface javax.servlet.http.HttpServletResponse
  - setHeader
```
public void setHeader(String name,
             String value)
```
    Specified by:
    
    setHeader in interface javax.servlet.http.HttpServletResponse
  - addHeader
```
public void addHeader(String name,
             String value)
```
    Specified by:
    
    addHeader in interface javax.servlet.http.HttpServletResponse
  - setIntHeader
```
public void setIntHeader(String name,
                int value)
```
    Specified by:
    
    setIntHeader in interface javax.servlet.http.HttpServletResponse
  - addIntHeader
```
public void addIntHeader(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
```
public void setStatus(int sc,
             String sm)
```
    Deprecated. As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String). Sets the status code and message for this response.
    
    Specified by:
    
    setStatus in interface javax.servlet.http.HttpServletResponse
    
    Parameters:
    sc - the status code
    sm - the status message

Class ResteasyHttpServletResponseWrapper

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.ServletResponseWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.http.HttpServletResponse

Methods inherited from interface javax.servlet.ServletResponse

Constructor Detail

ResteasyHttpServletResponseWrapper

Method Detail

getHttpServletResponse

getResponse

getCharacterEncoding

getContentType

getOutputStream

getWriter

setCharacterEncoding

setContentLength

setContentType

setBufferSize

getBufferSize

flushBuffer

resetBuffer

isCommitted

reset

setLocale

getLocale

addCookie

containsHeader

encodeURL

encodeRedirectURL

encodeUrl

encodeRedirectUrl

sendError

sendError

sendRedirect

setDateHeader

addDateHeader

setHeader

addHeader

setIntHeader

addIntHeader

setStatus

setStatus