Class ServletResponseWrapperInclude

java.lang.Object
javax.servlet.ServletResponseWrapper
javax.servlet.http.HttpServletResponseWrapper
org.apache.jasper.runtime.ServletResponseWrapperInclude
All Implemented Interfaces:
javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
public class ServletResponseWrapperInclude extends javax.servlet.http.HttpServletResponseWrapper
ServletResponseWrapper used by the JSP 'include' action. This wrapper response object is passed to RequestDispatcher.include(), so that the output of the included resource is appended to that of the including page.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    private static class 
    ServletResponseWrapperInclude.PrintWriterWrapper
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private boolean
    canFlushWriter
    Indicates whether or not the wrapped JspWriter can be flushed.
    private JspWriter
    jspWriter
     
    private PrintWriter
    printWriter
    PrintWriter which appends to the JspWriter of the including page.

    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
    Description
    ServletResponseWrapperInclude(javax.servlet.ServletResponse response, JspWriter jspWriter)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canFlush()
    Indicates whether or not the wrapped JspWriter can be flushed.
    void
    flushBuffer()
    Flush the wrapper around the JspWriter of the including page.
    javax.servlet.ServletOutputStream
    getOutputStream()
     
    PrintWriter
    getWriter()
    Returns a wrapper around the JspWriter of the including page.
    boolean
    hasData()
    Are there any data to be flushed ?
    void
    resetBuffer()
    Clears the output buffer of the JspWriter associated with the including page.

    Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

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

    Methods inherited from class javax.servlet.ServletResponseWrapper

    getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, reset, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse

    Methods inherited from class 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, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

  • Field Details

    • printWriter

      private PrintWriter printWriter
      PrintWriter which appends to the JspWriter of the including page.

    • jspWriter

      private JspWriter jspWriter

    • canFlushWriter

      private boolean canFlushWriter
      Indicates whether or not the wrapped JspWriter can be flushed.

  • Constructor Details

    • ServletResponseWrapperInclude

      public ServletResponseWrapperInclude(javax.servlet.ServletResponse response, JspWriter jspWriter)

  • Method Details

    • getWriter

      public PrintWriter getWriter() throws IOException
      Returns a wrapper around the JspWriter of the including page.
      Specified by:
      getWriter in interface javax.servlet.ServletResponse
      Overrides:
      getWriter in class javax.servlet.ServletResponseWrapper
      Throws:
      IOException

    • getOutputStream

      public javax.servlet.ServletOutputStream getOutputStream() throws IOException
      Specified by:
      getOutputStream in interface javax.servlet.ServletResponse
      Overrides:
      getOutputStream in class javax.servlet.ServletResponseWrapper
      Throws:
      IOException

    • resetBuffer

      public void resetBuffer()
      Clears the output buffer of the JspWriter associated with the including page.
      Specified by:
      resetBuffer in interface javax.servlet.ServletResponse
      Overrides:
      resetBuffer in class javax.servlet.ServletResponseWrapper

    • flushBuffer

      public void flushBuffer() throws IOException
      Flush the wrapper around the JspWriter of the including page.
      Specified by:
      flushBuffer in interface javax.servlet.ServletResponse
      Overrides:
      flushBuffer in class javax.servlet.ServletResponseWrapper
      Throws:
      IOException

    • canFlush

      public boolean canFlush()
      Indicates whether or not the wrapped JspWriter can be flushed. (BodyContent objects cannot be flushed)

    • hasData

      public boolean hasData()
      Are there any data to be flushed ?