planetj.servlet.wrapper
Class WrappedHttpServletResponse

java.lang.Object
  planetj.servlet.wrapper.ServletResponseWrapper
      planetj.servlet.wrapper.HttpServletResponseWrapper
          planetj.servlet.wrapper.WrappedHttpServletResponse

Direct Known Subclasses:

PleaseWaitResponse

public class WrappedHttpServletResponse

extends HttpServletResponseWrapper

Stores data written to the response and allows it to be obtained later. Can be used to capture JSP HTML output.

Constructor Summary

WrappedHttpServletResponse(HttpServletResponse wrapMe)
Creates a response wrapper which buffers the output.

Method Summary

void	addCookie(Cookie cookie)
void	addDateHeader(java.lang.String name, long date)
void	addHeader(java.lang.String name, java.lang.String value)
void	addIntHeader(java.lang.String name, int value)
void	flushBuffer()
java.io.Reader	getOutputAsReader() Provides the buffered output as a Reader.
java.lang.String	getOutputAsString() Provides the buffered output as a String.
ServletOutputStream	getOutputStream()
java.io.PrintWriter	getWriter()
int	outputSize()
boolean	prefersReader()
void	sendError(int sc) This actually sends to the real response and flags an error condition.
void	sendError(int sc, java.lang.String msg) This actually sends to the real response and flags an error condition.
void	setContentLength(int len)
void	setContentType(java.lang.String type)
void	setDateHeader(java.lang.String name, long date)
void	setHeader(java.lang.String name, java.lang.String value)
void	setIntHeader(java.lang.String name, int value)
void	setLocale(java.util.Locale loc)
void	setStatus(int sc)
void	setStatus(int sc, java.lang.String sm)

Methods inherited from class planetj.servlet.wrapper.HttpServletResponseWrapper

addCookie, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendRedirect

Methods inherited from class planetj.servlet.wrapper.ServletResponseWrapper

getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

WrappedHttpServletResponse

public WrappedHttpServletResponse(HttpServletResponse wrapMe)

Creates a response wrapper which buffers the output.

Method Detail

addCookie

public void addCookie(Cookie cookie)

Overrides:

addCookie in class HttpServletResponseWrapper

See Also:

ServletResponse#addCookie

addDateHeader

public void addDateHeader(java.lang.String name,
                          long date)

Overrides:

addDateHeader in class HttpServletResponseWrapper

See Also:

ServletResponse#addDateHeader

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Overrides:

addHeader in class HttpServletResponseWrapper

See Also:

ServletResponse#addHeader

addIntHeader

public void addIntHeader(java.lang.String name,
                         int value)

Overrides:

addIntHeader in class HttpServletResponseWrapper

See Also:

ServletResponse#addIntHeader

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Overrides:

flushBuffer in class ServletResponseWrapper

Throws:

java.io.IOException

See Also:

ServletResponse#flushBuffer

getOutputAsReader

public java.io.Reader getOutputAsReader()
                                 throws java.io.UnsupportedEncodingException

Provides the buffered output as a Reader. If output was written using a ServletOutputStream, the charset defined in the content-type is used to decode the data. If no charset is set, the default encoding is assumed.

Throws:

java.io.UnsupportedEncodingException

getOutputAsString

public java.lang.String getOutputAsString()
                                   throws java.io.UnsupportedEncodingException

Provides the buffered output as a String. If output was written using a ServletOutputStream, the charset defined in the content-type is used to decode the data. If no charset is set, the default encoding is assumed.

Throws:

java.io.UnsupportedEncodingException

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws java.io.IOException

Overrides:

getOutputStream in class ServletResponseWrapper

Throws:

java.io.IOException

See Also:

ServletResponse#getOutputStream

getWriter

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

Overrides:

getWriter in class ServletResponseWrapper

Throws:

java.io.IOException

See Also:

ServletResponse#getWriter

outputSize

public int outputSize()

Returns:

the amount of data written to the output stream.

prefersReader

public boolean prefersReader()

Returns:

true if it is more efficient to call getOutputAsReader() than getOutputAsString(). If false, getOutputAsString() should be used.

sendError

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

This actually sends to the real response and flags an error condition.

Overrides:

sendError in class HttpServletResponseWrapper

Throws:

java.io.IOException

See Also:

ServletResponse#addIntHeader

sendError

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

This actually sends to the real response and flags an error condition.

Overrides:

sendError in class HttpServletResponseWrapper

Throws:

java.io.IOException

See Also:

ServletResponse#addIntHeader

setContentLength

public void setContentLength(int len)

Overrides:

setContentLength in class ServletResponseWrapper

See Also:

ServletResponse#setContentLength

setContentType

public void setContentType(java.lang.String type)

Overrides:

setContentType in class ServletResponseWrapper

See Also:

ServletResponse#setContentType

setDateHeader

public void setDateHeader(java.lang.String name,
                          long date)

Overrides:

setDateHeader in class HttpServletResponseWrapper

See Also:

ServletResponse#setDateHeader

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

Overrides:

setHeader in class HttpServletResponseWrapper

See Also:

ServletResponse#setHeader

setIntHeader

public void setIntHeader(java.lang.String name,
                         int value)

Overrides:

setIntHeader in class HttpServletResponseWrapper

See Also:

ServletResponse#setIntHeader

setLocale

public void setLocale(java.util.Locale loc)

Overrides:

setLocale in class ServletResponseWrapper

See Also:

ServletResponse#setLocale

setStatus

public void setStatus(int sc)

Overrides:

setStatus in class HttpServletResponseWrapper

See Also:

ServletResponse#setStatus

setStatus

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

Overrides:

setStatus in class HttpServletResponseWrapper

See Also:

ServletResponse#setStatus