org.springframework.web.util

Class ContentCachingResponseWrapper

java.lang.Object

HttpServletResponseWrapper

org.springframework.web.util.ContentCachingResponseWrapper

Direct Known Subclasses:

ShallowEtagHeaderFilter.HttpStreamingAwareContentCachingResponseWrapper

public class ContentCachingResponseWrapper
extends HttpServletResponseWrapper

javax.servlet.http.HttpServletResponse wrapper that caches all content written to the output stream and writer, and allows this content to be retrieved via a byte array.

Used e.g. by ShallowEtagHeaderFilter.

Since:

4.1.3

Author:

Juergen Hoeller

See Also:

ContentCachingRequestWrapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ContentCachingResponseWrapper.ResponsePrintWriter
private class	ContentCachingResponseWrapper.ResponseServletOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
private FastByteArrayOutputStream	content
private java.lang.Integer	contentLength
private ServletOutputStream	outputStream
private int	statusCode
private java.io.PrintWriter	writer

Constructor Summary

Constructors

Constructor and Description
ContentCachingResponseWrapper(HttpServletResponse response) Create a new ContentCachingResponseWrapper for the given servlet response.

Method Summary

Modifier and Type	Method and Description
void	copyBodyToResponse() Copy the complete cached body content to the response.
protected void	copyBodyToResponse(boolean complete) Copy the cached body content to the response.
byte[]	getContentAsByteArray() Return the cached response content as a byte array.
java.io.InputStream	getContentInputStream() Return an InputStream to the cached content.
int	getContentSize() Return the current size of the cached content.
ServletOutputStream	getOutputStream()
int	getStatusCode() Return the status code as specified on the response.
java.io.PrintWriter	getWriter()
void	reset()
void	resetBuffer()
void	sendError(int sc)
void	sendError(int sc, java.lang.String msg)
void	sendRedirect(java.lang.String location)
void	setBufferSize(int size)
void	setContentLength(int len)
void	setContentLengthLong(long len)
void	setStatus(int sc)
void	setStatus(int sc, java.lang.String sm)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

content

private final FastByteArrayOutputStream content

outputStream

private final ServletOutputStream outputStream

writer

private java.io.PrintWriter writer

statusCode

private int statusCode

contentLength

private java.lang.Integer contentLength

Constructor Detail

ContentCachingResponseWrapper

public ContentCachingResponseWrapper(HttpServletResponse response)

Create a new ContentCachingResponseWrapper for the given servlet response.

Parameters:

response - the original servlet response

Method Detail

setStatus

public void setStatus(int sc)

setStatus

public void setStatus(int sc,
                      java.lang.String sm)

sendError

public void sendError(int sc)
               throws java.io.IOException

Throws:

java.io.IOException

sendError

public void sendError(int sc,
                      java.lang.String msg)
               throws java.io.IOException

Throws:

java.io.IOException

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException

Throws:

java.io.IOException

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws java.io.IOException

Throws:

java.io.IOException

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Throws:

java.io.IOException

setContentLength

public void setContentLength(int len)

setContentLengthLong

public void setContentLengthLong(long len)

setBufferSize

public void setBufferSize(int size)

resetBuffer

public void resetBuffer()

reset

public void reset()

getStatusCode

public int getStatusCode()

Return the status code as specified on the response.

getContentAsByteArray

public byte[] getContentAsByteArray()

Return the cached response content as a byte array.

getContentInputStream

public java.io.InputStream getContentInputStream()

Return an InputStream to the cached content.

Since:

4.2

getContentSize

public int getContentSize()

Return the current size of the cached content.

Since:

4.2

copyBodyToResponse

public void copyBodyToResponse()
                        throws java.io.IOException

Copy the complete cached body content to the response.

Throws:

java.io.IOException

Since:

4.2

copyBodyToResponse

protected void copyBodyToResponse(boolean complete)
                           throws java.io.IOException

Copy the cached body content to the response.

Parameters:

complete - whether to set a corresponding content length for the complete cached body content

Throws:

java.io.IOException

Since:

4.2