Class BufferedResponseHandler

All Implemented Interfaces:
Handler, HandlerContainer, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle
Direct Known Subclasses:
FileBufferedResponseHandler

public class BufferedResponseHandler extends HandlerWrapper

A Handler that can apply a HttpOutput.Interceptor mechanism to buffer the entire response content until the output is closed. This allows the commit to be delayed until the response is complete and thus headers and response status can be changed while writing the body.

Note that the decision to buffer is influenced by the headers and status at the first write, and thus subsequent changes to those headers will not influence the decision to buffer or not.

Note also that there are no memory limits to the size of the buffer, thus this handler can represent an unbounded memory commitment if the content generated can also be unbounded.

  • Constructor Details

    • BufferedResponseHandler

      public BufferedResponseHandler()
  • Method Details

    • getMethodIncludeExclude

      public IncludeExclude<String> getMethodIncludeExclude()
    • getPathIncludeExclude

      public IncludeExclude<String> getPathIncludeExclude()
    • getMimeIncludeExclude

      public IncludeExclude<String> getMimeIncludeExclude()
    • isMimeTypeBufferable

      protected boolean isMimeTypeBufferable(String mimetype)
    • isPathBufferable

      protected boolean isPathBufferable(String requestURI)
    • shouldBuffer

      protected boolean shouldBuffer(HttpChannel channel, boolean last)
    • handle

      public void handle(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) throws IOException, jakarta.servlet.ServletException
      Description copied from interface: Handler
      Handle a request.
      Specified by:
      handle in interface Handler
      Overrides:
      handle in class HandlerWrapper
      Parameters:
      target - The target of the request - either a URI or a name.
      baseRequest - The original unwrapped request object.
      request - The request either as the Request object or a wrapper of that request.
      response - The response as the Response object or a wrapper of that request.
      Throws:
      IOException - if unable to handle the request or response processing
      jakarta.servlet.ServletException - if unable to handle the request or response due to underlying servlet issue
    • newBufferedInterceptor

      protected BufferedResponseHandler.BufferedInterceptor newBufferedInterceptor(HttpChannel httpChannel, HttpOutput.Interceptor interceptor)