ExpiresFilter.XHttpServletResponse (Apache Tomcat 9.0.120 API Documentation)
Description: declaration: package: org.apache.catalina.filters, class: ExpiresFilter, class: XHttpServletResponse

# Class ExpiresFilter.XHttpServletResponse

java.lang.Object
javax.servlet.ServletResponseWrapper
javax.servlet.http.HttpServletResponseWrapper
org.apache.catalina.filters.ExpiresFilter.XHttpServletResponse

All Implemented Interfaces:
  `HttpServletResponse, ServletResponse`

Enclosing class:
  `ExpiresFilter`

public class ExpiresFilter.XHttpServletResponse extends HttpServletResponseWrapper

Wrapping extension of the `HttpServletResponse` to wrap the "Start Write Response Body" event.

For performance optimization : this extended response holds the `lastModifiedHeader` and `cacheControlHeader` values access to the slow `HttpServletResponseWrapper.getHeader(String)` and to spare the `string` to `date` to `long` conversion.

- ## Field Summary

  ### Fields inherited from interface 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
  `XHttpServletResponse(HttpServletRequest request, HttpServletResponse response)`
  Creates a new XHttpServletResponse wrapping the given response.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addDateHeader(String name, long date)`
  The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.
  `void`
  `addHeader(String name, String value)`
  The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.
  `String`
  `getCacheControlHeader()`
  Returns the Cache-Control header value.
  `long`
  `getLastModifiedHeader()`
  Returns the Last-Modified header value as a timestamp.
  `ServletOutputStream`
  `getOutputStream()`
  The default behavior of this method is to return getOutputStream() on the wrapped response object.
  `PrintWriter`
  `getWriter()`
  The default behavior of this method is to return getWriter() on the wrapped response object.
  `boolean`
  `isLastModifiedHeaderSet()`
  Checks if the Last-Modified header has been set.
  `boolean`
  `isWriteResponseBodyStarted()`
  Checks if writing the response body has started.
  `void`
  `reset()`
  The default behavior of this method is to call reset() on the wrapped response object.
  `void`
  `setDateHeader(String name, long date)`
  The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.
  `void`
  `setHeader(String name, String value)`
  The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.
  `void`
  `setWriteResponseBodyStarted(boolean writeResponseBodyStarted)`
  Sets whether writing the response body has started.

  ### Methods inherited from class HttpServletResponseWrapper

  `addCookie, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, sendRedirect, setIntHeader, setStatus, setStatus, setTrailerFields`

  ### Methods inherited from class ServletResponseWrapper

  `flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, resetBuffer, 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 ServletResponse

  `flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale`

- ## Constructor Details

  - ### XHttpServletResponse

    public XHttpServletResponse(HttpServletRequest request, HttpServletResponse response)
    Creates a new XHttpServletResponse wrapping the given response.
    Parameters:
      `request` - the HTTP servlet request
      `response` - the HTTP servlet response to wrap

- ## Method Details

  - ### addDateHeader

    public void addDateHeader(String name, long date)
    Description copied from class: `javax.servlet.http.HttpServletResponseWrapper`
    The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.
    Specified by:
      `addDateHeader` in interface `HttpServletResponse`
    Overrides:
      `addDateHeader` in class `HttpServletResponseWrapper`
    Parameters:
      `name` - the name of the header to set
      `date` - the additional date value
    See Also:
      - `HttpServletResponse.setDateHeader(String, long)`

  - ### addHeader

    public void addHeader(String name, String value)
    Description copied from class: `javax.servlet.http.HttpServletResponseWrapper`
    The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.
    Specified by:
      `addHeader` in interface `HttpServletResponse`
    Overrides:
      `addHeader` in class `HttpServletResponseWrapper`
    Parameters:
      `name` - the name of the header
      `value` - the additional 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.setHeader(String, String)`

  - ### getCacheControlHeader

    public String getCacheControlHeader()
    Returns the Cache-Control header value.
    Returns:
      the Cache-Control header value, or `null` if not set

  - ### getLastModifiedHeader

    public long getLastModifiedHeader()
    Returns the Last-Modified header value as a timestamp.
    Returns:
      the Last-Modified header timestamp

  - ### getOutputStream

    public ServletOutputStream getOutputStream() throws IOException
    Description copied from class: `javax.servlet.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:
      `IOException` - if an input or output exception occurred
    See Also:
      - `ServletResponse.getWriter()`

  - ### getWriter

    public PrintWriter getWriter() throws IOException
    Description copied from class: `javax.servlet.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:
      `IOException` - if an input or output exception occurred
    See Also:
      - `ServletResponse.getOutputStream()`
      - `ServletResponse.setCharacterEncoding(String)`

  - ### isLastModifiedHeaderSet

    public boolean isLastModifiedHeaderSet()
    Checks if the Last-Modified header has been set.
    Returns:
      `true` if the Last-Modified header has been set

  - ### isWriteResponseBodyStarted

    public boolean isWriteResponseBodyStarted()
    Checks if writing the response body has started.
    Returns:
      `true` if writing the response body has started

  - ### reset

    public void reset()
    Description copied from class: `javax.servlet.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()`

  - ### setDateHeader

    public void setDateHeader(String name, long date)
    Description copied from class: `javax.servlet.http.HttpServletResponseWrapper`
    The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.
    Specified by:
      `setDateHeader` in interface `HttpServletResponse`
    Overrides:
      `setDateHeader` in class `HttpServletResponseWrapper`
    Parameters:
      `name` - the name of the header to set
      `date` - the assigned date value
    See Also:
      - `HttpServletResponse.containsHeader(String)`
      - `HttpServletResponse.addDateHeader(String, long)`

  - ### setHeader

    public void setHeader(String name, String value)
    Description copied from class: `javax.servlet.http.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(String)`
      - `HttpServletResponse.addHeader(String, String)`

  - ### setWriteResponseBodyStarted

    public void setWriteResponseBodyStarted(boolean writeResponseBodyStarted)
    Sets whether writing the response body has started.
    Parameters:
      `writeResponseBodyStarted` - `true` if writing has started