Package org.apache.jasper.runtime
Class ServletResponseWrapperInclude
- java.lang.Object
-
- jakarta.servlet.ServletResponseWrapper
-
- jakarta.servlet.http.HttpServletResponseWrapper
-
- org.apache.jasper.runtime.ServletResponseWrapperInclude
-
- All Implemented Interfaces:
HttpServletResponse,ServletResponse
public class ServletResponseWrapperInclude extends 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.- Author:
- Pierre Delisle
-
-
Field Summary
-
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 ServletResponseWrapperInclude(ServletResponse response, JspWriter jspWriter)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ServletOutputStreamgetOutputStream()The default behavior of this method is to return getOutputStream() on the wrapped response object.java.io.PrintWritergetWriter()Returns a wrapper around the JspWriter of the including page.voidresetBuffer()Clears the output buffer of the JspWriter associated with the including page.-
Methods inherited from class jakarta.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 jakarta.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, reset, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, 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
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, reset, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale
-
-
-
-
Constructor Detail
-
ServletResponseWrapperInclude
public ServletResponseWrapperInclude(ServletResponse response, JspWriter jspWriter)
-
-
Method Detail
-
getWriter
public java.io.PrintWriter getWriter() throws java.io.IOExceptionReturns a wrapper around the JspWriter of the including page.- Specified by:
getWriterin interfaceServletResponse- Overrides:
getWriterin classServletResponseWrapper- Returns:
- a
PrintWriterobject that can return character data to the client - Throws:
java.io.UnsupportedEncodingException- if the character encoding returned bygetCharacterEncodingcannot be usedjava.io.IOException- if an input or output exception occurred- See Also:
ServletResponse.getOutputStream(),ServletResponse.setCharacterEncoding(java.lang.String)
-
getOutputStream
public ServletOutputStream getOutputStream() throws java.io.IOException
Description copied from class:jakarta.servlet.ServletResponseWrapperThe default behavior of this method is to return getOutputStream() on the wrapped response object.- Specified by:
getOutputStreamin interfaceServletResponse- Overrides:
getOutputStreamin classServletResponseWrapper- Returns:
- a
ServletOutputStreamfor writing binary data - Throws:
java.io.IOException- if an input or output exception occurred- See Also:
ServletResponse.getWriter()
-
resetBuffer
public void resetBuffer()
Clears the output buffer of the JspWriter associated with the including page.- Specified by:
resetBufferin interfaceServletResponse- Overrides:
resetBufferin classServletResponseWrapper- See Also:
ServletResponse.setBufferSize(int),ServletResponse.getBufferSize(),ServletResponse.isCommitted(),ServletResponse.reset()
-
-