Package org.eclipse.jetty.server.handler

Class HandlerWrapper

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

All Implemented Interfaces:

Handler, HandlerContainer, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.LifeCycle

Direct Known Subclasses:

AsyncDelayHandler, BufferedResponseHandler, DebugHandler, GzipHandler, IdleTimeoutHandler, InetAccessHandler, IPAccessHandler, RequestLogHandler, ResourceHandler, ScopedHandler, Server, ShutdownHandler, StatisticsHandler, 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 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.LifeCycle

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Handler	_handler

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

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
HandlerWrapper()

Method Summary

Modifier and Type	Method	Description
void	destroy()
protected void	expandChildren(java.util.List<Handler> list, java.lang.Class<?> byClass)
Handler	getHandler()
Handler[]	getHandlers()
void	handle(java.lang.String target, Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Handle a request.
void	insertHandler(HandlerWrapper wrapper)	Replace the current handler with another HandlerWrapper linked to the current handler.
void	setHandler(Handler handler)

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

doStart, doStop, dumpThis, getServer

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

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

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

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

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

addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

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

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

_handler

protected Handler _handler

Constructor Detail

HandlerWrapper

public HandlerWrapper()

Method Detail

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.

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(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.

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

expandChildren

protected void expandChildren(java.util.List<Handler> list,
                              java.lang.Class<?> byClass)

Overrides:

expandChildren in class AbstractHandlerContainer

destroy

public void destroy()

Specified by:

destroy in interface org.eclipse.jetty.util.component.Destroyable

Specified by:

destroy in interface Handler

Overrides:

destroy in class AbstractHandler