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,org.eclipse.jetty.util.component.Container,org.eclipse.jetty.util.component.Destroyable,org.eclipse.jetty.util.component.Dumpable,org.eclipse.jetty.util.component.LifeCycle
@ManagedObject("Context Handler Collection") public class ContextHandlerCollection extends HandlerCollectionContextHandlerCollection. ThisHandlerCollectionis creates a Map of contexts to it's contained handlers based on the context path and virtual hosts of any containedContextHandlers. 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
org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener
-
-
Constructor Summary
Constructors Constructor Description ContextHandlerCollection()ContextHandlerCollection(ContextHandler... contexts)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ContextHandleraddContext(String contextPath, String resourceBase)Add a context handler.protected voiddoStart()Class<?>getContextClass()voidhandle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)Handle a request.voidmapContexts()Remap the context paths.voidsetContextClass(Class<? extends ContextHandler> contextClass)voidsetHandlers(Handler[] handlers)-
Methods inherited from class org.eclipse.jetty.server.handler.HandlerCollection
addHandler, destroy, expandChildren, getHandlers, prependHandler, removeHandler
-
Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer
doShutdown, expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer
-
Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler
doError, doStop, getServer
-
Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle
addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans
-
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString
-
-
-
-
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:
setHandlersin classHandlerCollection- Parameters:
handlers- The handlers to set.
-
doStart
protected void doStart() throws Exception- Overrides:
doStartin classAbstractHandler- Throws:
Exception
-
handle
public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
Description copied from interface:HandlerHandle a request.- Specified by:
handlein interfaceHandler- Overrides:
handlein classHandlerCollection- Parameters:
target- The target of the request - either a URI or a name.baseRequest- The original unwrapped request object.request- The request either as theRequestobject or a wrapper of that request. Themethod can be used access the Request object if required.HttpConnection.getCurrentConnection().getHttpChannel().getRequest()response- The response as theResponseobject or a wrapper of that request. Themethod can be used access the Response object if required.HttpConnection.getCurrentConnection().getHttpChannel().getResponse()- Throws:
IOException- if unable to handle the request or response processingServletException- 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(String contextPath, String resourceBase)
Add a context handler.- Parameters:
contextPath- The context path to addresourceBase- the base (root) Resource- Returns:
- the ContextHandler just added
-
getContextClass
public Class<?> getContextClass()
- Returns:
- The class to use to add new Contexts
-
setContextClass
public void setContextClass(Class<? extends ContextHandler> contextClass)
- Parameters:
contextClass- The class to use to add new Contexts
-
-