Module org.eclipse.jetty.server

Package org.eclipse.jetty.server

Interface Handler.Singleton

All Superinterfaces:

org.eclipse.jetty.util.component.Destroyable, Handler, Handler.Container, org.eclipse.jetty.util.thread.Invocable, org.eclipse.jetty.util.component.LifeCycle, Request.Handler

All Known Implementing Classes:

BufferedResponseHandler, ConditionalHandler, ConditionalHandler.Abstract, ConditionalHandler.DontHandle, ConditionalHandler.ElseNext, ConditionalHandler.Reject, ConditionalHandler.SkipNext, ConnectHandler, ContextHandler, CrossOriginHandler, DebugHandler, DelayedHandler, EventsHandler, GracefulHandler, GzipHandler, Handler.Wrapper, HotSwapHandler, IdleTimeoutHandler, InetAccessHandler, LatencyRecordingHandler, MovedContextHandler, QoSHandler, ResourceHandler, ResourceHandler.ResourceContext, SecuredRedirectHandler, Server, ShutdownHandler, SizeLimitHandler, SizeLimitHandler, StateTrackingHandler, StatisticsHandler, StatisticsHandler.MinimumDataRateHandler, ThreadLimitHandler, TryPathsHandler

Enclosing interface:

Handler

@ManagedObject
public static interface Handler.Singleton
extends Handler.Container

A Handler.Container that can contain one single other Handler.

This is a "singleton" in the sense of Collections.singleton(Object) and not in the sense of the singleton pattern of a single instance per JVM.

See Also:

• for an implementation of Singleton.
• Handler.Collection

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Handler

Handler.Abstract, 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 org.eclipse.jetty.server.Request.Handler

Request.Handler.AbortException

Field Summary

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

__nonBlocking, NOOP

Method Summary

Modifier and Type	Method	Description
static Handler	checkHandler(Handler.Singleton singleton, Handler handler)	Utility method to perform sanity checks on a {Handler to be added to the given Singleton.
Handler	getHandler()
default List<Handler>	getHandlers()
default Handler.Singleton	getTail()
default void	insertHandler(Handler.Singleton handler)	Inserts the given Handler (and possible chain of Handlers) between this Handler and its current child.
default void	setHandler(Supplier<Handler> supplier)	Sets the child Handler supplied by the given Supplier.
void	setHandler(Handler handler)
static Handler	updateHandler(Handler.Singleton singleton, Handler handler)	Utility method to perform sanity checks before updating the given Handler to the given Singleton, typically used in implementations of setHandler(Handler).

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

destroy

Methods inherited from interface org.eclipse.jetty.server.Handler

getServer, setServer

Methods inherited from interface org.eclipse.jetty.server.Handler.Container

getContainer, getDescendant, getDescendants, getDescendants

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

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

Methods inherited from interface org.eclipse.jetty.server.Request.Handler

getInvocationType, handle

Method Details

getHandler

@ManagedAttribute(value="The child Handler of this Container",
                  readonly=true)
Handler getHandler()

Returns:

the child Handler

setHandler

void setHandler(Handler handler)

Parameters:

handler - The Handler to set as a child

setHandler

default void setHandler(Supplier<Handler> supplier)

Sets the child Handler supplied by the given Supplier.

Parameters:

supplier - the Handler supplier

getHandlers

default List<Handler> getHandlers()

Specified by:

getHandlers in interface Handler.Container

Returns:

an immutable collection of Handlers directly contained by this Handler.

insertHandler

default void insertHandler(Handler.Singleton handler)

Inserts the given Handler (and possible chain of Handlers) between this Handler and its current child.

For example, if this Handler A has a child B, inserting Handler X built as a chain Handlers X-Y-Z results in the structure A-X-Y-Z-B.

Parameters:

handler - the Handler to insert

getTail

default Handler.Singleton getTail()

Returns:

the tail Handler.Singleton of a chain of Handler.Singletons

updateHandler

static Handler updateHandler(Handler.Singleton singleton,
 Handler handler)

Utility method to perform sanity checks before updating the given Handler to the given Singleton, typically used in implementations of setHandler(Handler).

The sanity checks are:

• Check for the server start state and whether the invocation type is compatible
• Check for Handler loops
• Sets the Server on the Handler
• Update the beans on the Singleton if it is a ContainerLifeCycle

Parameters:

singleton - the Singleton to set the Handler

handler - the Handler to set

Returns:

The Handler to set

See Also:

• checkHandler(Singleton, Handler)

checkHandler

static Handler checkHandler(Handler.Singleton singleton,
 Handler handler)

Utility method to perform sanity checks on a {Handler to be added to the given Singleton.

The sanity checks are:

• Check for the server start state and whether the invocation type is compatible
• Check for Handler loops
• Sets the Server on the Handler
• Update the beans on the Singleton if it is a ContainerLifeCycle

Parameters:

singleton - the Singleton to set the Handler

handler - the Handler to set

Returns:

The Handler to set