Package org.eclipse.jetty.server.handler

Class ContextHandlerCollection

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

org.eclipse.jetty.server.handler.ContextHandlerCollection

All Implemented Interfaces:

Handler, HandlerContainer, Container, Destroyable, Dumpable, LifeCycle

@ManagedObject("Context Handler Collection")
public class ContextHandlerCollection
extends HandlerCollection

ContextHandlerCollection. This HandlerCollection is creates a Map of contexts to it's contained handlers based on the context path and virtual hosts of any contained ContextHandlers. The contexts do not need to be directly contained, only children of the contained handlers. Multiple contexts may have the same context path and they are called in order until one handles the request.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

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

Container.InheritedListener, Container.Listener

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

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
ContextHandlerCollection()
ContextHandlerCollection(ContextHandler... contexts)

Method Summary

Modifier and Type	Method	Description
ContextHandler	addContext(java.lang.String contextPath, java.lang.String resourceBase)	Add a context handler.
protected void	doStart()
java.lang.Class<?>	getContextClass()
void	handle(java.lang.String target, Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Handle a request.
void	mapContexts()	Remap the context paths.
void	setContextClass(java.lang.Class<? extends ContextHandler> contextClass)
void	setHandlers(Handler[] handlers)

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

doError, 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, getContainedBeans, getContainedBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

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

addHandler, destroy, expandChildren, getHandlers, prependHandler, removeHandler, toString

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextHandlerCollection

public ContextHandlerCollection()

ContextHandlerCollection

public ContextHandlerCollection(ContextHandler... contexts)

Method Detail

mapContexts

@ManagedOperation("update the mapping of context path to context")
public void mapContexts()

Remap the context paths.

setHandlers

public void setHandlers(Handler[] handlers)

Overrides:

setHandlers in class HandlerCollection

Parameters:

handlers - The handlers to set.

doStart

protected void doStart()
                throws java.lang.Exception

Overrides:

doStart in class AbstractHandler

Throws:

java.lang.Exception

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.

Specified by:

handle in interface Handler

Overrides:

handle in class HandlerCollection

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)

addContext

public ContextHandler addContext(java.lang.String contextPath,
                                 java.lang.String resourceBase)

Add a context handler.

Parameters:

contextPath - The context path to add

resourceBase - the base (root) Resource

Returns:

the ContextHandler just added

getContextClass

public java.lang.Class<?> getContextClass()

Returns:

The class to use to add new Contexts

setContextClass

public void setContextClass(java.lang.Class<? extends ContextHandler> contextClass)

Parameters:

contextClass - The class to use to add new Contexts