org.apache.juneau.rest.util

Class CachingHttpServletResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.apache.juneau.rest.util.CachingHttpServletResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse

public class CachingHttpServletResponse
extends HttpServletResponseWrapper

Wraps an HttpServletResponse and caches the output stream in a separate buffer for debugging purposes.

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

Modifier	Constructor and Description
protected	CachingHttpServletResponse(HttpServletResponse res) Constructor.

Method Summary

Modifier and Type	Method and Description
byte[]	getBody() Returns the body of the servlet response without consuming the stream.
ServletOutputStream	getOutputStream()
static CachingHttpServletResponse	wrap(HttpServletResponse res) Wraps the specified response inside a CachingHttpServletResponse if it isn't already.

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, 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.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

Constructor Detail

CachingHttpServletResponse

protected CachingHttpServletResponse(HttpServletResponse res)
                              throws IOException

Constructor.

Parameters:

res - The wrapped servlet response.

Throws:

IOException - Thrown by underlying stream.

Method Detail

wrap

public static CachingHttpServletResponse wrap(HttpServletResponse res)
                                       throws IOException

Wraps the specified response inside a CachingHttpServletResponse if it isn't already.

Parameters:

res - The response to wrap.

Returns:

The wrapped request.

Throws:

IOException - Thrown by underlying body stream.

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Specified by:

getOutputStream in interface ServletResponse

Overrides:

getOutputStream in class ServletResponseWrapper

Throws:

IOException

getBody

public byte[] getBody()

Returns the body of the servlet response without consuming the stream.

Returns:

The body of the response.