Package org.eclipse.jetty.server.handler

Class HandlerCollection

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ContextHandlerCollection, HandlerList

@ManagedObject("Handler of multiple handlers")
public class HandlerCollection
extends AbstractHandlerContainer

A collection of handlers.

The default implementations calls all handlers in list order, regardless of the response status or exceptions. Derived implementation may alter the order or the conditions of calling the contained handlers.

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 inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

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

Constructor Summary

Constructors

Constructor	Description
HandlerCollection()
HandlerCollection(boolean mutableWhenRunning)

Method Summary

Modifier and Type	Method	Description
void	addHandler(Handler handler)
void	destroy()
protected void	expandChildren(java.util.List<Handler> list, java.lang.Class<?> byClass)
Handler[]	getHandlers()
void	handle(java.lang.String target, Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Handle a request.
void	removeHandler(Handler handler)
void	setHandlers(Handler[] handlers)
java.lang.String	toString()

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, wait, wait, wait

Constructor Detail

HandlerCollection

public HandlerCollection()

HandlerCollection

public HandlerCollection(boolean mutableWhenRunning)

Method Detail

getHandlers

@ManagedAttribute(value="Wrapped handlers",
                  readonly=true)
public Handler[] getHandlers()

Returns:

Returns the handlers.

setHandlers

public void setHandlers(Handler[] handlers)

Parameters:

handlers - The handlers to set.

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

See Also:

Handler.handle(String, Request, HttpServletRequest, HttpServletResponse)

addHandler

public void addHandler(Handler handler)

removeHandler

public void removeHandler(Handler handler)

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object