jodd.servlet.filter

Class GzipResponseWrapper

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

jodd.servlet.filter.GzipResponseWrapper

All Implemented Interfaces:

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

public class GzipResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper

Implementation of HttpServletResponseWrapper that works with the GzipResponseStream implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	contentType Content type.
protected javax.servlet.http.HttpServletResponse	origResponse Original response.
protected javax.servlet.ServletOutputStream	stream The ServletOutputStream that has been returned by getOutputStream(), if any.
protected int	threshold The threshold number to compress.
protected java.io.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
GzipResponseWrapper(javax.servlet.http.HttpServletResponse response) Calls the parent constructor which creates a ServletResponse adaptor wrapping the given response object.

Method Summary

Modifier and Type	Method and Description
javax.servlet.ServletOutputStream	createOutputStream() Creates and returns a ServletOutputStream to write the content associated with this Response.
void	finishResponse() Finishes a response.
void	flushBuffer() Flushes the buffer and commit this response.
javax.servlet.ServletOutputStream	getOutputStream() Returns the servlet output stream associated with this Response.
java.io.PrintWriter	getWriter() Returns the writer associated with this Response.
void	setCompressionThreshold(int threshold) Set threshold number
void	setContentLength(int length) Ignores set content length on zipped stream.
void	setContentLengthLong(long length) Servlets v3.1 introduce this method, so we need to have it here in case they are used.
void	setContentType(java.lang.String contentType) Set content type

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

Field Detail

origResponse

protected javax.servlet.http.HttpServletResponse origResponse

Original response.

stream

protected javax.servlet.ServletOutputStream stream

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

writer

protected java.io.PrintWriter writer

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

threshold

protected int threshold

The threshold number to compress.

contentType

protected java.lang.String contentType

Content type.

Constructor Detail

GzipResponseWrapper

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

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

Method Detail

setContentType

public void setContentType(java.lang.String contentType)

Set content type

Specified by:

setContentType in interface javax.servlet.ServletResponse

Overrides:

setContentType in class javax.servlet.ServletResponseWrapper

setCompressionThreshold

public void setCompressionThreshold(int threshold)

Set threshold number

createOutputStream

public javax.servlet.ServletOutputStream createOutputStream()
                                                     throws java.io.IOException

Creates and returns a ServletOutputStream to write the content associated with this Response.

Throws:

java.io.IOException

finishResponse

public void finishResponse()

Finishes a response.

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Flushes the buffer and commit this response.

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Overrides:

flushBuffer in class javax.servlet.ServletResponseWrapper

Throws:

java.io.IOException

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException

Returns the servlet output stream associated with this Response.

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class javax.servlet.ServletResponseWrapper

Throws:

java.io.IOException

getWriter

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

Returns the writer associated with this Response.

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class javax.servlet.ServletResponseWrapper

Throws:

java.io.IOException

setContentLength

public void setContentLength(int length)

Ignores set content length on zipped stream.

Specified by:

setContentLength in interface javax.servlet.ServletResponse

Overrides:

setContentLength in class javax.servlet.ServletResponseWrapper

setContentLengthLong

public void setContentLengthLong(long length)

Servlets v3.1 introduce this method, so we need to have it here in case they are used. See: https://github.com/oblac/jodd/issues/189

Specified by:

setContentLengthLong in interface javax.servlet.ServletResponse

Overrides:

setContentLengthLong in class javax.servlet.ServletResponseWrapper