com.helger.servlet.response.gzip

Class AbstractCompressedResponseWrapper

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

com.helger.servlet.response.StatusAwareHttpResponseWrapper

com.helger.servlet.response.gzip.AbstractCompressedResponseWrapper

All Implemented Interfaces:

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

Direct Known Subclasses:

DeflateResponse, GZIPResponse

@NotThreadSafe
public abstract class AbstractCompressedResponseWrapper
extends StatusAwareHttpResponseWrapper

Abstract output stream switching HttpServletResponseWrapper

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MIN_COMPRESSED_SIZE The minimum size where compression is applied

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
AbstractCompressedResponseWrapper(javax.servlet.http.HttpServletRequest aHttpRequest, javax.servlet.http.HttpServletResponse aHttpResponse, String sContentEncoding)

Method Summary

Modifier and Type	Method and Description
void	addHeader(String sHeaderName, String sHeaderValue)
protected abstract AbstractCompressedServletOutputStream	createCompressedOutputStream(javax.servlet.http.HttpServletRequest aHttpRequest, javax.servlet.http.HttpServletResponse aHttpResponse, String sContentEncoding, long nContentLength, int nMinCompressSize)
void	finish()
void	flushBuffer()
javax.servlet.ServletOutputStream	getOutputStream()
PrintWriter	getWriter()
void	reset()
void	resetBuffer()
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(String sLocation)
void	setContentType(String sContentType)
void	setHeader(String sHeaderName, String sHeaderValue)
void	setIntHeader(String sHeaderName, int nHeaderValue)
void	setNoCompression()
void	setStatus(int sc)
void	setStatus(int sc, String sm) Deprecated.

Methods inherited from class com.helger.servlet.response.StatusAwareHttpResponseWrapper

addDateHeader, addIntHeader, getStatusCode, headerMap, setContentLength, setDateHeader, wrap

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

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

Field Detail

DEFAULT_MIN_COMPRESSED_SIZE

public static final int DEFAULT_MIN_COMPRESSED_SIZE

The minimum size where compression is applied

See Also:

Constant Field Values

Constructor Detail

AbstractCompressedResponseWrapper

public AbstractCompressedResponseWrapper(@Nonnull
                                         javax.servlet.http.HttpServletRequest aHttpRequest,
                                         @Nonnull
                                         javax.servlet.http.HttpServletResponse aHttpResponse,
                                         @Nonnull @Nonempty
                                         String sContentEncoding)

Method Detail

setNoCompression

public void setNoCompression()

setContentType

public void setContentType(@Nonnull
                           String sContentType)

Specified by:

setContentType in interface javax.servlet.ServletResponse

Overrides:

setContentType in class StatusAwareHttpResponseWrapper

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class StatusAwareHttpResponseWrapper

setStatus

@Deprecated
public void setStatus(int sc,
                                   String sm)

Deprecated.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class StatusAwareHttpResponseWrapper

addHeader

public void addHeader(String sHeaderName,
                      String sHeaderValue)

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addHeader in class StatusAwareHttpResponseWrapper

setHeader

public void setHeader(String sHeaderName,
                      String sHeaderValue)

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setHeader in class StatusAwareHttpResponseWrapper

setIntHeader

public void setIntHeader(String sHeaderName,
                         int nHeaderValue)

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setIntHeader in class StatusAwareHttpResponseWrapper

flushBuffer

public final void flushBuffer()
                       throws IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Overrides:

flushBuffer in class javax.servlet.ServletResponseWrapper

Throws:

IOException

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

Overrides:

reset in class StatusAwareHttpResponseWrapper

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

Overrides:

resetBuffer in class javax.servlet.ServletResponseWrapper

sendError

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

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class StatusAwareHttpResponseWrapper

Throws:

IOException

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class StatusAwareHttpResponseWrapper

Throws:

IOException

sendRedirect

public void sendRedirect(String sLocation)
                  throws IOException

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class StatusAwareHttpResponseWrapper

Throws:

IOException

finish

public final void finish()
                  throws IOException

Throws:

IOException

createCompressedOutputStream

@Nonnull
protected abstract AbstractCompressedServletOutputStream createCompressedOutputStream(@Nonnull
                                                                                                javax.servlet.http.HttpServletRequest aHttpRequest,
                                                                                                @Nonnull
                                                                                                javax.servlet.http.HttpServletResponse aHttpResponse,
                                                                                                @Nonnull @Nonempty
                                                                                                String sContentEncoding,
                                                                                                long nContentLength,
                                                                                                @Nonnegative
                                                                                                int nMinCompressSize)
                                                                                         throws IOException

Throws:

IOException

getOutputStream

@Nonnull
public final javax.servlet.ServletOutputStream getOutputStream()
                                                                  throws IOException

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class javax.servlet.ServletResponseWrapper

Throws:

IOException

getWriter

@Nonnull
public final PrintWriter getWriter()
                                      throws IOException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class javax.servlet.ServletResponseWrapper

Throws:

IOException