compressionFilters

Class CompressionServletResponseWrapper

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

compressionFilters.CompressionServletResponseWrapper

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class CompressionServletResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper

Implementation of HttpServletResponseWrapper that works with the CompressionServletResponseStream implementation..

Author:

Amy Roh, Dmitri Valdin

Field Summary

Fields

Modifier and Type	Field and Description
protected int	compressionBuffer The compression buffer size
protected String[]	compressionMimeTypes The mime types to compress
protected int	compressionThreshold The threshold number to compress
protected int	debug Debug level
protected static String	info Descriptive information about this Response implementation.
protected javax.servlet.http.HttpServletResponse	origResponse Original response
protected javax.servlet.ServletOutputStream	stream The ServletOutputStream that has been returned by getOutputStream(), if any.
protected PrintWriter	writer The PrintWriter that has been returned by getWriter(), if any.

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
CompressionServletResponseWrapper(javax.servlet.http.HttpServletResponse response) Calls the parent constructor which creates a ServletResponse adaptor wrapping the given response object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String name, String value)
javax.servlet.ServletOutputStream	createOutputStream() Create and return a ServletOutputStream to write the content associated with this Response.
void	finishResponse() Finish a response.
void	flushBuffer() Flush the buffer and commit this response.
String	getHeader(String name)
javax.servlet.ServletOutputStream	getOutputStream() Return the servlet output stream associated with this Response.
PrintWriter	getWriter() Return the writer associated with this Response.
void	setCompressionBuffer(int buffer) Set compression buffer
void	setCompressionMimeTypes(String[] mimeTypes) Set compressible mime types
void	setCompressionThreshold(int threshold) Set threshold number
void	setDebugLevel(int debug) Set debug level
void	setHeader(String name, String value)

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeaderNames, getHeaders, getStatus, sendError, sendError, sendRedirect, setDateHeader, 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

Field Detail

origResponse

protected javax.servlet.http.HttpServletResponse origResponse

Original response

info

protected static final String info

Descriptive information about this Response implementation.

See Also:

Constant Field Values

stream

protected javax.servlet.ServletOutputStream stream

The ServletOutputStream that has been returned by getOutputStream(), if any.

writer

protected PrintWriter writer

The PrintWriter that has been returned by getWriter(), if any.

compressionThreshold

protected int compressionThreshold

The threshold number to compress

compressionBuffer

protected int compressionBuffer

The compression buffer size

compressionMimeTypes

protected String[] compressionMimeTypes

The mime types to compress

debug

protected int debug

Debug level

Constructor Detail

CompressionServletResponseWrapper

public CompressionServletResponseWrapper(javax.servlet.http.HttpServletResponse response)

Calls the parent constructor which creates a ServletResponse adaptor wrapping the given response object.

Method Detail

setCompressionThreshold

public void setCompressionThreshold(int threshold)

Set threshold number

setCompressionBuffer

public void setCompressionBuffer(int buffer)

Set compression buffer

setCompressionMimeTypes

public void setCompressionMimeTypes(String[] mimeTypes)

Set compressible mime types

setDebugLevel

public void setDebugLevel(int debug)

Set debug level

createOutputStream

public javax.servlet.ServletOutputStream createOutputStream()
                                                     throws IOException

Create and return a ServletOutputStream to write the content associated with this Response.

Throws:

IOException - if an input/output error occurs

finishResponse

public void finishResponse()

Finish a response.

flushBuffer

public void flushBuffer()
                 throws IOException

Flush the buffer and commit this response.

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Overrides:

flushBuffer in class javax.servlet.ServletResponseWrapper

Throws:

IOException - if an input/output error occurs

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException

Return the servlet output stream associated with this Response.

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class javax.servlet.ServletResponseWrapper

Throws:

IllegalStateException - if getWriter has already been called for this response

IOException - if an input/output error occurs

getWriter

public PrintWriter getWriter()
                      throws IOException

Return the writer associated with this Response.

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class javax.servlet.ServletResponseWrapper

Throws:

IllegalStateException - if getOutputStream has already been called for this response

IOException - if an input/output error occurs

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

getHeader in class javax.servlet.http.HttpServletResponseWrapper

addHeader

public void addHeader(String name,
             String value)

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addHeader in class javax.servlet.http.HttpServletResponseWrapper

setHeader

public void setHeader(String name,
             String value)

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setHeader in class javax.servlet.http.HttpServletResponseWrapper