Class HandlerWrapper

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.ee9.nested.AbstractHandler

org.eclipse.jetty.ee9.nested.AbstractHandlerContainer

org.eclipse.jetty.ee9.nested.HandlerWrapper

All Implemented Interfaces:

Handler, HandlerContainer, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

Direct Known Subclasses:

AsyncDelayHandler, BufferedResponseHandler, DebugHandler, IdleTimeoutHandler, InetAccessHandler, ResourceHandler, ScopedHandler, SecuredRedirectHandler, SecurityHandler, ThreadLimitHandler

@ManagedObject("Handler wrapping another Handler")
public class HandlerWrapper
extends AbstractHandlerContainer

A HandlerWrapper acts as a Handler but delegates the handle method and life cycle events to a delegate. This is primarily used to implement the Decorator pattern.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractHandler

AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected Handler	_handler

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
HandlerWrapper()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroys the managed Destroyable beans in the reverse order they were added.
protected void	expandChildren(List<Handler> list, Class<?> byClass)
Handler	getHandler()
Handler[]	getHandlers()
HandlerWrapper	getTail()	Get the tail of a chain of HandlerWrappers.
void	handle(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handle a request.
void	insertHandler(HandlerWrapper wrapper)	Replace the current handler with another HandlerWrapper linked to the current handler.
static void	setAsParent(Handler.Container parent, Handler handler)	Make a Handler.Container the parent of a Handler
void	setHandler(Handler handler)

Methods inherited from class AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

Methods inherited from class AbstractHandler

doError, doStart, doStop, getServer

Methods inherited from class ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, 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 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 Container

getCachedBeans, getEventListeners

Methods inherited from interface Dumpable

dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Methods inherited from interface LifeCycle

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

Field Details

_handler

protected Handler _handler

Constructor Details

HandlerWrapper

public HandlerWrapper()

Method Details

getHandler

@ManagedAttribute(value="Wrapped Handler",
                  readonly=true)
public Handler getHandler()

Returns:

Returns the handlers.

getHandlers

public Handler[] getHandlers()

Returns:

Returns the handlers.

setHandler

public void setHandler(Handler handler)

Parameters:

handler - Set the Handler which should be wrapped.

getTail

public HandlerWrapper getTail()

Get the tail of a chain of HandlerWrappers.

Returns:

The last HandlerWrapper in a chain of HandlerWrappers

insertHandler

public void insertHandler(HandlerWrapper wrapper)

Replace the current handler with another HandlerWrapper linked to the current handler.

This is equivalent to:

  wrapper.setHandler(getHandler());
  setHandler(wrapper);

Parameters:

wrapper - the wrapper to insert

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

Specified by:

handle in class AbstractHandler

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

expandChildren

protected void expandChildren(List<Handler> list,
 Class<?> byClass)

Overrides:

expandChildren in class AbstractHandlerContainer

destroy

public void destroy()

Description copied from class: ContainerLifeCycle

Destroys the managed Destroyable beans in the reverse order they were added.

Specified by:

destroy in interface Destroyable

Specified by:

destroy in interface Handler

Overrides:

destroy in class AbstractHandler

setAsParent

public static void setAsParent(Handler.Container parent,
 Handler handler)

Make a Handler.Container the parent of a Handler

Parameters:

parent - The Handler.Container that will be the parent

handler - The Handler that will be the child