org.eclipse.jetty.http.gzip
Class GzipResponseWrapper

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          org.eclipse.jetty.http.gzip.GzipResponseWrapper

All Implemented Interfaces:

HttpServletResponse, ServletResponse

Direct Known Subclasses:

IncludableGzipFilter.IncludableResponseWrapper

public class GzipResponseWrapper
extends HttpServletResponseWrapper

Field Summary

static int	DEFAULT_BUFFER_SIZE
static int	DEFAULT_MIN_GZIP_SIZE

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

GzipResponseWrapper(HttpServletRequest request, HttpServletResponse response)
Instantiates a new gzip response wrapper.

Method Summary

void	addHeader(String name, String value)
void	finish() Finish.
void	flushBuffer()
ServletOutputStream	getOutputStream()
PrintWriter	getWriter()
protected GzipStream	newGzipStream(HttpServletRequest request, HttpServletResponse response, long contentLength, int bufferSize, int minGzipSize) Allows derived implementations to replace GzipStream implementation.
protected PrintWriter	newWriter(OutputStream out, String encoding) Allows derived implementations to replace PrintWriter implementation.
void	noGzip() No gzip.
void	reset()
void	resetBuffer()
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(String location)
void	setBufferSize(int bufferSize)
void	setContentLength(int length)
protected void	setContentLength(long length)
void	setContentType(String ct)
void	setHeader(String name, String value)
void	setIntHeader(String name, int value)
void	setMimeTypes(Set<String> mimeTypes) Sets the mime types.
void	setMinGzipSize(int minGzipSize) Sets the min gzip size.
void	setStatus(int sc)
void	setStatus(int sc, String sm)

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, setDateHeader

Methods inherited from class javax.servlet.ServletResponseWrapper

getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, setCharacterEncoding, 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, setCharacterEncoding, setLocale

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

DEFAULT_MIN_GZIP_SIZE

public static final int DEFAULT_MIN_GZIP_SIZE

See Also:

Constant Field Values

Constructor Detail

GzipResponseWrapper

public GzipResponseWrapper(HttpServletRequest request,
                           HttpServletResponse response)

Instantiates a new gzip response wrapper.

Parameters:

request - the request

response - the response

Method Detail

setMimeTypes

public void setMimeTypes(Set<String> mimeTypes)

Sets the mime types.

Parameters:

mimeTypes - the new mime types

setBufferSize

public void setBufferSize(int bufferSize)

Specified by:

setBufferSize in interface ServletResponse

Overrides:

setBufferSize in class ServletResponseWrapper

See Also:

ServletResponseWrapper.setBufferSize(int)

setMinGzipSize

public void setMinGzipSize(int minGzipSize)

Sets the min gzip size.

Parameters:

minGzipSize - the new min gzip size

setContentType

public void setContentType(String ct)

Specified by:

setContentType in interface ServletResponse

Overrides:

setContentType in class ServletResponseWrapper

See Also:

ServletResponseWrapper.setContentType(java.lang.String)

setStatus

public void setStatus(int sc,
                      String sm)

Specified by:

setStatus in interface HttpServletResponse

Overrides:

setStatus in class HttpServletResponseWrapper

See Also:

HttpServletResponseWrapper.setStatus(int, java.lang.String)

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface HttpServletResponse

Overrides:

setStatus in class HttpServletResponseWrapper

See Also:

HttpServletResponseWrapper.setStatus(int)

setContentLength

public void setContentLength(int length)

Specified by:

setContentLength in interface ServletResponse

Overrides:

setContentLength in class ServletResponseWrapper

See Also:

ServletResponseWrapper.setContentLength(int)

setContentLength

protected void setContentLength(long length)

addHeader

public void addHeader(String name,
                      String value)

Specified by:

addHeader in interface HttpServletResponse

Overrides:

addHeader in class HttpServletResponseWrapper

See Also:

HttpServletResponseWrapper.addHeader(java.lang.String, java.lang.String)

setHeader

public void setHeader(String name,
                      String value)

Specified by:

setHeader in interface HttpServletResponse

Overrides:

setHeader in class HttpServletResponseWrapper

See Also:

HttpServletResponseWrapper.setHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(String name,
                         int value)

Specified by:

setIntHeader in interface HttpServletResponse

Overrides:

setIntHeader in class HttpServletResponseWrapper

See Also:

HttpServletResponseWrapper.setIntHeader(java.lang.String, int)

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface ServletResponse

Overrides:

flushBuffer in class ServletResponseWrapper

Throws:

IOException

See Also:

ServletResponseWrapper.flushBuffer()

reset

public void reset()

Specified by:

reset in interface ServletResponse

Overrides:

reset in class ServletResponseWrapper

See Also:

ServletResponseWrapper.reset()

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

Overrides:

resetBuffer in class ServletResponseWrapper

See Also:

ServletResponseWrapper.resetBuffer()

sendError

public void sendError(int sc,
                      String msg)
               throws IOException

Specified by:

sendError in interface HttpServletResponse

Overrides:

sendError in class HttpServletResponseWrapper

Throws:

IOException

See Also:

HttpServletResponseWrapper.sendError(int, java.lang.String)

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface HttpServletResponse

Overrides:

sendError in class HttpServletResponseWrapper

Throws:

IOException

See Also:

HttpServletResponseWrapper.sendError(int)

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Overrides:

sendRedirect in class HttpServletResponseWrapper

Throws:

IOException

See Also:

HttpServletResponseWrapper.sendRedirect(java.lang.String)

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Specified by:

getOutputStream in interface ServletResponse

Overrides:

getOutputStream in class ServletResponseWrapper

Throws:

IOException

See Also:

ServletResponseWrapper.getOutputStream()

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface ServletResponse

Overrides:

getWriter in class ServletResponseWrapper

Throws:

IOException

See Also:

ServletResponseWrapper.getWriter()

noGzip

public void noGzip()

No gzip.

finish

public void finish()
            throws IOException

Finish.

Throws:

IOException - Signals that an I/O exception has occurred.

newGzipStream

protected GzipStream newGzipStream(HttpServletRequest request,
                                   HttpServletResponse response,
                                   long contentLength,
                                   int bufferSize,
                                   int minGzipSize)
                            throws IOException

Allows derived implementations to replace GzipStream implementation.

Parameters:

request - the request

response - the response

contentLength - the content length

bufferSize - the buffer size

minGzipSize - the min gzip size

Returns:

the gzip stream

Throws:

IOException - Signals that an I/O exception has occurred.

newWriter

protected PrintWriter newWriter(OutputStream out,
                                String encoding)
                         throws UnsupportedEncodingException

Allows derived implementations to replace PrintWriter implementation.

Parameters:

out - the out

encoding - the encoding

Returns:

the prints the writer

Throws:

UnsupportedEncodingException - the unsupported encoding exception