Class EagerContentHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.Handler.Abstract

org.eclipse.jetty.server.Handler.AbstractContainer

org.eclipse.jetty.server.Handler.Wrapper

org.eclipse.jetty.server.handler.ConditionalHandler

org.eclipse.jetty.server.handler.ConditionalHandler.ElseNext

org.eclipse.jetty.server.handler.EagerContentHandler

All Implemented Interfaces:

Handler, Handler.Container, Handler.Singleton, Request.Handler, 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, org.eclipse.jetty.util.thread.Invocable

Direct Known Subclasses:

DelayedHandler

public class EagerContentHandler
extends ConditionalHandler.ElseNext

A ConditionalHandler that can eagerly load content asynchronously before calling the next handler. Typically this handler is deployed before an application that uses blocking IO to read the request body. By using this handler, such an application can be run in a way so that it never (or seldom) blocks on request content. This gives many of the benefits of asynchronous IO without the need to write an asynchronous application.

The handler uses the configured EagerContentHandler.FormContentLoaderFactory instances to eagerly load specific content types. By default, this handler supports eager loading of:

FormFields

Loaded and parsed in full by the EagerContentHandler.FormContentLoaderFactory

MultiPartFormData

Loaded and parsed in full by the EagerContentHandler.MultiPartContentLoaderFactory

Content.Chunk

Retained by the EagerContentHandler.RetainedContentLoaderFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EagerContentHandler.ContentLoader	An eager content processor, created by a EagerContentHandler.ContentLoaderFactory to asynchronous load content from a Request before calling the Request.Handler.handle(Request, Response, Callback) method of the passed Handler.
static interface	EagerContentHandler.ContentLoaderFactory	A factory to create new EagerContentHandler.ContentLoader instances for a specific mime type.
static class	EagerContentHandler.FormContentLoaderFactory	An EagerContentHandler.ContentLoaderFactory for MimeTypes.Type.FORM_ENCODED content, that uses FormFields.onFields(Request, Charset, int, int, Promise.Invocable) to asynchronously load and parse the content.
static class	EagerContentHandler.MultiPartContentLoaderFactory	An EagerContentHandler.ContentLoaderFactory for MimeTypes.Type.MULTIPART_FORM_DATA content, that uses MultiPartFormData.onParts(Content.Source, Attributes, String, MultiPartConfig, Promise.Invocable) to asynchronously load and parse the content.
static class	EagerContentHandler.RetainedContentLoaderFactory	An EagerContentHandler.ContentLoaderFactory for any content, that uses Retainable.retain() to eagerly load content with zero copies, until all content is read or a maximum size is exceeded.

Nested classes/interfaces inherited from class ConditionalHandler

ConditionalHandler.Abstract, ConditionalHandler.ConnectorPredicate, ConditionalHandler.DontHandle, ConditionalHandler.ElseNext, ConditionalHandler.InetAddressPatternPredicate, ConditionalHandler.MethodPredicate, ConditionalHandler.NextElseReject, ConditionalHandler.PathSpecPredicate, ConditionalHandler.PredicateSet, ConditionalHandler.Reject, ConditionalHandler.SkipNext

Nested classes/interfaces inherited from class Handler.Abstract

Handler.Abstract.NonBlocking

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, org.eclipse.jetty.util.component.Dumpable.DumpAppendable

Nested classes/interfaces inherited from interface Handler

Handler.AbstractContainer, Handler.Collection, Handler.Container, Handler.Sequence, Handler.Singleton, Handler.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

org.eclipse.jetty.util.thread.Invocable.Callable, org.eclipse.jetty.util.thread.Invocable.InvocationType, org.eclipse.jetty.util.thread.Invocable.ReadyTask, org.eclipse.jetty.util.thread.Invocable.Task

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

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

Nested classes/interfaces inherited from interface Request.Handler

Request.Handler.AbortException

Field Summary

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

LEGEND

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
EagerContentHandler()	Construct an EagerContentHandler with the default EagerContentHandler.ContentLoaderFactory set
EagerContentHandler(Handler handler)	Construct an EagerContentHandler with the default EagerContentHandler.ContentLoaderFactory set
EagerContentHandler(EagerContentHandler.ContentLoaderFactory... factories)	Construct an EagerContentHandler with the specific EagerContentHandler.ContentLoaderFactory instances
EagerContentHandler(Handler handler, EagerContentHandler.ContentLoaderFactory... factories)	Construct an EagerContentHandler with the specific EagerContentHandler.ContentLoaderFactory instances

Method Summary

Modifier and Type	Method	Description
protected boolean	onConditionsMet(Request request, Response response, org.eclipse.jetty.util.Callback callback)	Handle a request that has met the conditions.

Methods inherited from class ConditionalHandler.ElseNext

onConditionsNotMet

Methods inherited from class ConditionalHandler

clear, doStart, dump, exclude, exclude, exclude, excludeInetAddressPattern, excludeMethod, excludePath, from, from, handle, include, include, include, includeInetAddressPattern, includeMethod, includePath, nextHandler

Methods inherited from class Handler.Wrapper

getHandler, getInvocationType, setHandler

Methods inherited from class Handler.AbstractContainer

findContainerOf, getDescendant, getDescendants, isDynamic, setDynamic, setServer

Methods inherited from class Handler.Abstract

destroy, doStop, getServer

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

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, 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 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.Destroyable

destroy

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 Handler

getServer, setServer

Methods inherited from interface Handler.Container

getContainer, getDescendant, getDescendants, getDescendants

Methods inherited from interface Handler.Singleton

getHandlers, getTail, insertHandler, setHandler

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

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

Constructor Details

EagerContentHandler

public EagerContentHandler()

Construct an EagerContentHandler with the default EagerContentHandler.ContentLoaderFactory set

EagerContentHandler

public EagerContentHandler(Handler handler)

Construct an EagerContentHandler with the default EagerContentHandler.ContentLoaderFactory set

Parameters:

handler - The next handler (also can be set with Handler.Wrapper.setHandler(Handler)

EagerContentHandler

public EagerContentHandler(EagerContentHandler.ContentLoaderFactory... factories)

Construct an EagerContentHandler with the specific EagerContentHandler.ContentLoaderFactory instances

Parameters:

factories - The EagerContentHandler.ContentLoaderFactory instances used to eagerly load content.

EagerContentHandler

public EagerContentHandler(Handler handler,
 EagerContentHandler.ContentLoaderFactory... factories)

Construct an EagerContentHandler with the specific EagerContentHandler.ContentLoaderFactory instances

Parameters:

handler - The next handler (also can be set with Handler.Wrapper.setHandler(Handler)

factories - The EagerContentHandler.ContentLoaderFactory instances used to eagerly load content.

Method Details

onConditionsMet

protected boolean onConditionsMet(Request request,
 Response response,
 org.eclipse.jetty.util.Callback callback)
                           throws Exception

Description copied from class: ConditionalHandler

Handle a request that has met the conditions. Typically, the implementation will provide optional handling and then call the ConditionalHandler.nextHandler(Request, Response, Callback) method to continue handling.

Specified by:

onConditionsMet in class ConditionalHandler

Parameters:

request - The request to handle

response - The response to generate

callback - The callback for completion

Returns:

True if this handler will complete the callback

Throws:

Exception - If there is a problem handling

See Also:

• Request.Handler.handle(Request, Response, Callback)