Package org.apache.sling.scripting.core.servlet

Class CaptureResponseWrapper

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.apache.sling.scripting.core.servlet.CaptureResponseWrapper

All Implemented Interfaces:

HttpServletResponse, ServletResponse

public final class CaptureResponseWrapper
extends HttpServletResponseWrapper

Extends the HttpServletResponse to wrap the response and capture the results.

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	Description
CaptureResponseWrapper(HttpServletResponse response)	Construct a new CaptureResponseWrapper.

Method Summary

Modifier and Type	Method	Description
void	flushBuffer()	The default behavior of this method is to call flushBuffer() on the wrapped response object.
String	getCapturedCharacterResponse()
ServletOutputStream	getOutputStream()	The default behavior of this method is to return getOutputStream() on the wrapped response object.
PrintWriter	getWriter()	The default behavior of this method is to return getWriter() on the wrapped response object.
boolean	isBinaryResponse()	Returns true if the response is binary.

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

getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletResponse

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

Constructor Details

CaptureResponseWrapper

public CaptureResponseWrapper(HttpServletResponse response)

Construct a new CaptureResponseWrapper.

Parameters:

response - the response to wrap

Method Details

isBinaryResponse

public boolean isBinaryResponse()

Returns true if the response is binary.

Returns:

true if the response is binary, false otherwise

flushBuffer

public void flushBuffer()
                 throws IOException

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call flushBuffer() on the wrapped response object.

Specified by:

flushBuffer in interface ServletResponse

Overrides:

flushBuffer in class ServletResponseWrapper

Throws:

IOException - if an I/O occurs during the flushing of the response

See Also:

• ServletResponse.setBufferSize(int)
• ServletResponse.getBufferSize()
• ServletResponse.isCommitted()
• ServletResponse.reset()

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Description copied from class: ServletResponseWrapper

The default behavior of this method is to return getOutputStream() on the wrapped response object.

Specified by:

getOutputStream in interface ServletResponse

Overrides:

getOutputStream in class ServletResponseWrapper

Returns:

a ServletOutputStream for writing binary data

Throws:

IOException - if an input or output exception occurred

See Also:

• ServletResponse.getWriter()

getWriter

public PrintWriter getWriter()
                      throws IOException

Description copied from class: ServletResponseWrapper

The default behavior of this method is to return getWriter() on the wrapped response object.

Specified by:

getWriter in interface ServletResponse

Overrides:

getWriter in class ServletResponseWrapper

Returns:

a PrintWriter object that can return character data to the client

Throws:

IOException - if an input or output exception occurred

See Also:

• ServletResponse.getOutputStream()
• ServletResponse.setCharacterEncoding(java.lang.String)

getCapturedCharacterResponse

public String getCapturedCharacterResponse()
                                    throws IOException

Returns:

the captured character response data

Throws:

IOException - if no character response data captured