Package org.jumpmind.symmetric.web.compression

Class CompressionServletResponseWrapper

java.lang.Object
jakarta.servlet.ServletResponseWrapper
jakarta.servlet.http.HttpServletResponseWrapper
org.jumpmind.symmetric.web.compression.CompressionServletResponseWrapper
All Implemented Interfaces:
jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse
public class CompressionServletResponseWrapper extends jakarta.servlet.http.HttpServletResponseWrapper
Implementation of HttpServletResponseWrapper that works with the CompressionServletResponseStream implementation.. This package is derived from the Jakarta Tomcat examples compression filter and is distributed in SymmetricDS for convenience.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    contentType
    Content type
    protected static final String
    info
    Descriptive information about this Response implementation.
    protected jakarta.servlet.http.HttpServletResponse
    origResponse
    Original response
    protected jakarta.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 jakarta.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
    Description
    CompressionServletResponseWrapper(jakarta.servlet.http.HttpServletResponse response, int compressionLevel, int compressionStrategy)
    Calls the parent constructor which creates a ServletResponse adaptor wrapping the given response object.

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.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.
    jakarta.servlet.ServletOutputStream
    getOutputStream()
    Return the servlet output stream associated with this Response.
    PrintWriter
    getWriter()
    Return the writer associated with this Response.
    void
    setContentLength(int length)
     
    void
    setContentType(String contentType)
    Set content type

    Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

    addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectURL, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setTrailerFields

    Methods inherited from class jakarta.servlet.ServletResponseWrapper

    getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, 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 jakarta.servlet.ServletResponse

    getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLengthLong, setLocale

  • Field Details

    • origResponse

      protected jakarta.servlet.http.HttpServletResponse origResponse
      Original response

    • info

      protected static final String info
      Descriptive information about this Response implementation.
      See Also:

    • stream

      protected jakarta.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.

    • contentType

      protected String contentType
      Content type

  • Constructor Details

    • CompressionServletResponseWrapper

      public CompressionServletResponseWrapper(jakarta.servlet.http.HttpServletResponse response, int compressionLevel, int compressionStrategy)
      Calls the parent constructor which creates a ServletResponse adaptor wrapping the given response object.

  • Method Details

    • setContentType

      public void setContentType(String contentType)
      Set content type
      Specified by:
      setContentType in interface jakarta.servlet.ServletResponse
      Overrides:
      setContentType in class jakarta.servlet.ServletResponseWrapper

    • createOutputStream

      public jakarta.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 jakarta.servlet.ServletResponse
      Overrides:
      flushBuffer in class jakarta.servlet.ServletResponseWrapper
      Throws:
      IOException - if an input/output error occurs

    • getOutputStream

      public jakarta.servlet.ServletOutputStream getOutputStream() throws IOException
      Return the servlet output stream associated with this Response.
      Specified by:
      getOutputStream in interface jakarta.servlet.ServletResponse
      Overrides:
      getOutputStream in class jakarta.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 jakarta.servlet.ServletResponse
      Overrides:
      getWriter in class jakarta.servlet.ServletResponseWrapper
      Throws:
      IllegalStateException - if getOutputStream has already been called for this response
      IOException - if an input/output error occurs

    • setContentLength

      public void setContentLength(int length)
      Specified by:
      setContentLength in interface jakarta.servlet.ServletResponse
      Overrides:
      setContentLength in class jakarta.servlet.ServletResponseWrapper