Package org.eclipse.jetty.server.handler

Class BufferedResponseHandler

  • All Implemented Interfaces:
    Handler, HandlerContainer, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.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.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      protected static interface  BufferedResponseHandler.BufferedInterceptor
      An HttpOutput.Interceptor which is created by newBufferedInterceptor(HttpChannel, Interceptor) and is used by the implementation to buffer outgoing content.

      • Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

        org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

        org.eclipse.jetty.util.component.Dumpable.DumpableContainer

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

        org.eclipse.jetty.util.component.LifeCycle.Listener

    • Field Summary

      • Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

      • Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

        KEY

    • Constructor Detail

      • BufferedResponseHandler

        public BufferedResponseHandler()

    • Method Detail

      • getMethodIncludeExclude

        public org.eclipse.jetty.util.IncludeExclude<java.lang.String> getMethodIncludeExclude()

      • getPathIncludeExclude

        public org.eclipse.jetty.util.IncludeExclude<java.lang.String> getPathIncludeExclude()

      • getMimeIncludeExclude

        public org.eclipse.jetty.util.IncludeExclude<java.lang.String> getMimeIncludeExclude()

      • isMimeTypeBufferable

        protected boolean isMimeTypeBufferable​(java.lang.String mimetype)

      • isPathBufferable

        protected boolean isPathBufferable​(java.lang.String requestURI)

      • shouldBuffer

        protected boolean shouldBuffer​(HttpChannel channel,
                               boolean last)

      • handle

        public void handle​(java.lang.String target,
                   Request baseRequest,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.io.IOException,
                   javax.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. The HttpConnection.getCurrentConnection().getHttpChannel().getRequest() method can be used access the Request object if required.
        response - The response as the Response object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getResponse() method can be used access the Response object if required.
        Throws:
        java.io.IOException - if unable to handle the request or response processing
        javax.servlet.ServletException - if unable to handle the request or response due to underlying servlet issue