org.mortbay.servlet
Class GzipFilter.GZIPResponseWrapper

java.lang.Object
  extended by javax.servlet.ServletResponseWrapper
      extended by javax.servlet.http.HttpServletResponseWrapper
          extended by org.mortbay.servlet.GzipFilter.GZIPResponseWrapper
All Implemented Interfaces:
HttpServletResponse, ServletResponse
Direct Known Subclasses:
IncludableGzipFilter.IncludableResponseWrapper
Enclosing class:
GzipFilter

public class GzipFilter.GZIPResponseWrapper
extends HttpServletResponseWrapper


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
GzipFilter.GZIPResponseWrapper(HttpServletRequest request, HttpServletResponse response)
           
 
Method Summary
 void flushBuffer()
          The default behavior of this method is to call flushBuffer() on the wrapped response object.
 ServletOutputStream getOutputStream()
          The default behavior of this method is to return getOutputStream() on the wrapped response object.
 java.io.PrintWriter getWriter()
          The default behavior of this method is to return getWriter() on the wrapped response object.
protected  GzipFilter.GzipStream newGzipStream(HttpServletRequest request, HttpServletResponse response, long contentLength, int bufferSize, int minGzipSize)
           
 void reset()
          The default behavior of this method is to call reset() on the wrapped response object.
 void resetBuffer()
          The default behavior of this method is to call resetBuffer() on the wrapped response object.
 void sendError(int sc)
          The default behavior of this method is to call sendError(int sc) on the wrapped response object.
 void sendError(int sc, java.lang.String msg)
          The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.
 void sendRedirect(java.lang.String location)
          The default behavior of this method is to return sendRedirect(String location) on the wrapped response object.
 void setContentLength(int length)
          The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
 void setContentType(java.lang.String ct)
          The default behavior of this method is to call setContentType(String type) on the wrapped response object.
 void setHeader(java.lang.String name, java.lang.String value)
          The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.
 void setIntHeader(java.lang.String name, int value)
          The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.
 void setStatus(int sc)
          The default behavior of this method is to call setStatus(int sc) on the wrapped response object.
 void setStatus(int sc, java.lang.String sm)
          The default behavior of this method is to call setStatus(int sc, String sm) on the wrapped response object.
 
Methods inherited from class javax.servlet.http.HttpServletResponseWrapper
addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, setDateHeader
 
Methods inherited from class javax.servlet.ServletResponseWrapper
getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, 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, setBufferSize, setCharacterEncoding, setLocale
 

Constructor Detail

GzipFilter.GZIPResponseWrapper

public GzipFilter.GZIPResponseWrapper(HttpServletRequest request,
                                      HttpServletResponse response)
Method Detail

setContentType

public void setContentType(java.lang.String ct)
Description copied from class: ServletResponseWrapper
The default behavior of this method is to call setContentType(String type) on the wrapped response object.

Specified by:
setContentType in interface ServletResponse
Overrides:
setContentType in class ServletResponseWrapper
Parameters:
ct - a String specifying the MIME type of the content
See Also:
ServletResponse.setLocale(java.util.Locale), ServletResponse.setCharacterEncoding(java.lang.String), ServletResponse.getOutputStream(), ServletResponse.getWriter()

setStatus

public void setStatus(int sc,
                      java.lang.String sm)
Description copied from class: HttpServletResponseWrapper
The default behavior of this method is to call setStatus(int sc, String sm) on the wrapped response object.

Specified by:
setStatus in interface HttpServletResponse
Overrides:
setStatus in class HttpServletResponseWrapper
Parameters:
sc - the status code
sm - the status message

setStatus

public void setStatus(int sc)
Description copied from class: HttpServletResponseWrapper
The default behavior of this method is to call setStatus(int sc) on the wrapped response object.

Specified by:
setStatus in interface HttpServletResponse
Overrides:
setStatus in class HttpServletResponseWrapper
Parameters:
sc - the status code
See Also:
HttpServletResponse.sendError(int, java.lang.String)

setContentLength

public void setContentLength(int length)
Description copied from class: ServletResponseWrapper
The default behavior of this method is to call setContentLength(int len) on the wrapped response object.

Specified by:
setContentLength in interface ServletResponse
Overrides:
setContentLength in class ServletResponseWrapper
Parameters:
length - an integer specifying the length of the content being returned to the client; sets the Content-Length header

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)
Description copied from class: HttpServletResponseWrapper
The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.

Specified by:
setHeader in interface HttpServletResponse
Overrides:
setHeader in class HttpServletResponseWrapper
Parameters:
name - the name of the header
value - the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
See Also:
HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(java.lang.String name,
                         int value)
Description copied from class: HttpServletResponseWrapper
The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.

Specified by:
setIntHeader in interface HttpServletResponse
Overrides:
setIntHeader in class HttpServletResponseWrapper
Parameters:
name - the name of the header
value - the assigned integer value
See Also:
HttpServletResponse.containsHeader(java.lang.String), HttpServletResponse.addIntHeader(java.lang.String, int)

flushBuffer

public void flushBuffer()
                 throws java.io.IOException
Description copied from class: ServletResponseWrapper
The default behavior of this method is to call flushBuffer() on the wrapped response object.

Specified by:
flushBuffer in interface ServletResponse
Overrides:
flushBuffer in class ServletResponseWrapper
Throws:
java.io.IOException
See Also:
ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.isCommitted(), ServletResponse.reset()

reset

public void reset()
Description copied from class: ServletResponseWrapper
The default behavior of this method is to call reset() on the wrapped response object.

Specified by:
reset in interface ServletResponse
Overrides:
reset in class ServletResponseWrapper
See Also:
ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.isCommitted()

resetBuffer

public void resetBuffer()
Description copied from class: ServletResponseWrapper
The default behavior of this method is to call resetBuffer() on the wrapped response object.

Specified by:
resetBuffer in interface ServletResponse
Overrides:
resetBuffer in class ServletResponseWrapper
See Also:
ServletResponse.setBufferSize(int), ServletResponse.getBufferSize(), ServletResponse.isCommitted(), ServletResponse.reset()

sendError

public void sendError(int sc,
                      java.lang.String msg)
               throws java.io.IOException
Description copied from class: HttpServletResponseWrapper
The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.

Specified by:
sendError in interface HttpServletResponse
Overrides:
sendError in class HttpServletResponseWrapper
Parameters:
sc - the error status code
msg - the descriptive message
Throws:
java.io.IOException - If an input or output exception occurs

sendError

public void sendError(int sc)
               throws java.io.IOException
Description copied from class: HttpServletResponseWrapper
The default behavior of this method is to call sendError(int sc) on the wrapped response object.

Specified by:
sendError in interface HttpServletResponse
Overrides:
sendError in class HttpServletResponseWrapper
Parameters:
sc - the error status code
Throws:
java.io.IOException - If an input or output exception occurs

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException
Description copied from class: HttpServletResponseWrapper
The default behavior of this method is to return sendRedirect(String location) on the wrapped response object.

Specified by:
sendRedirect in interface HttpServletResponse
Overrides:
sendRedirect in class HttpServletResponseWrapper
Parameters:
location - the redirect location URL
Throws:
java.io.IOException - If an input or output exception occurs

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws java.io.IOException
Description copied from class: ServletResponseWrapper
The default behavior of this method is to return getOutputStream() on the wrapped response object.

Specified by:
getOutputStream in interface ServletResponse
Overrides:
getOutputStream in class ServletResponseWrapper
Returns:
a ServletOutputStream for writing binary data
Throws:
java.io.IOException - if an input or output exception occurred
See Also:
ServletResponse.getWriter()

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException
Description copied from class: ServletResponseWrapper
The default behavior of this method is to return getWriter() on the wrapped response object.

Specified by:
getWriter in interface ServletResponse
Overrides:
getWriter in class ServletResponseWrapper
Returns:
a PrintWriter object that can return character data to the client
Throws:
java.io.IOException - if an input or output exception occurred
See Also:
ServletResponse.getOutputStream(), ServletResponse.setCharacterEncoding(java.lang.String)

newGzipStream

protected GzipFilter.GzipStream newGzipStream(HttpServletRequest request,
                                              HttpServletResponse response,
                                              long contentLength,
                                              int bufferSize,
                                              int minGzipSize)
                                       throws java.io.IOException
Throws:
java.io.IOException


Copyright © 1995-2009 Mort Bay Consulting. All Rights Reserved.