Module org.eclipse.jetty.server

Package org.eclipse.jetty.server.handler

Class BufferedResponseHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.server.handler.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.server.handler.AbstractHandler

AbstractHandler.ErrorDispatchHandler

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

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

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.server.handler.HandlerWrapper

_handler

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

FAILED, STARTED, STARTING, STOPPED, STOPPING

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

KEY

Constructor Summary

Constructors

Constructor	Description
BufferedResponseHandler()

Method Summary

Modifier and Type	Method	Description
org.eclipse.jetty.util.IncludeExclude<java.lang.String>	getMethodIncludeExclude()
org.eclipse.jetty.util.IncludeExclude<java.lang.String>	getMimeIncludeExclude()
org.eclipse.jetty.util.IncludeExclude<java.lang.String>	getPathIncludeExclude()
void	handle(java.lang.String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handle a request.
protected boolean	isMimeTypeBufferable(java.lang.String mimetype)
protected boolean	isPathBufferable(java.lang.String requestURI)
protected BufferedResponseHandler.BufferedInterceptor	newBufferedInterceptor(HttpChannel httpChannel, HttpOutput.Interceptor interceptor)
protected boolean	shouldBuffer(HttpChannel channel, boolean last)

Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

destroy, expandChildren, getHandler, getHandlers, insertHandler, setHandler

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

doError, doStart, doStop, getServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Container

getCachedBeans, getEventListeners

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

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,
                   jakarta.servlet.http.HttpServletRequest request,
                   jakarta.servlet.http.HttpServletResponse response)
            throws java.io.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. 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

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)