org.omnifaces.servlet

Class HttpServletResponseOutputWrapper

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.omnifaces.servlet.HttpServletResponseOutputWrapper

All Implemented Interfaces:

HttpServletResponse, ServletResponse

Direct Known Subclasses:

BufferedHttpServletResponse, GzipHttpServletResponse

public abstract class HttpServletResponseOutputWrapper
extends HttpServletResponseWrapper

Convenience class for extending HttpServletResponseWrapper wherein the ServletOutputStream has to be replaced by a custom implementation. This saves the developer from writing repeated getOutputStream(), getWriter() and flushBuffer() boilerplate. All the developer has to do is to implement the createOutputStream() accordingly. This will in turn be used by both getOutputStream() and getWriter().

Since:

1.1

Author:

Bauke Scholtz

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
HttpServletResponseOutputWrapper(HttpServletResponse wrappedResponse) Construct a new HttpServletResponseOutputWrapper which wraps the given response.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the response body.
protected abstract ServletOutputStream	createOutputStream() Returns the custom implementation of the ServletOutputStream.
void	flushBuffer()
ServletOutputStream	getOutputStream()
PrintWriter	getWriter()

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, 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

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

Constructor Detail

HttpServletResponseOutputWrapper

public HttpServletResponseOutputWrapper(HttpServletResponse wrappedResponse)

Construct a new HttpServletResponseOutputWrapper which wraps the given response.

Parameters:

wrappedResponse - The wrapped response.

Method Detail

createOutputStream

protected abstract ServletOutputStream createOutputStream()

Returns the custom implementation of the ServletOutputStream.

Returns:

The custom implementation of the ServletOutputStream.

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Specified by:

getOutputStream in interface ServletResponse

Overrides:

getOutputStream in class ServletResponseWrapper

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface ServletResponse

Overrides:

getWriter in class ServletResponseWrapper

Throws:

IOException

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface ServletResponse

Overrides:

flushBuffer in class ServletResponseWrapper

Throws:

IOException

close

public void close()
           throws IOException

Close the response body. This closes any created writer or output stream.

Throws:

IOException - When an I/O error occurs.