- All Superinterfaces:
org.eclipse.jetty.util.component.Destroyable,org.eclipse.jetty.util.component.LifeCycle
- All Known Implementing Classes:
AbstractHandler,AbstractHandler.ErrorDispatchHandler,AbstractHandlerContainer,AsyncDelayHandler,BufferedResponseHandler,ContextHandler,DebugHandler,ErrorHandler,FileBufferedResponseHandler,HandlerCollection,HandlerList,HandlerWrapper,HotSwapHandler,IdleTimeoutHandler,InetAccessHandler,ResourceHandler,ScopedHandler,SecuredRedirectHandler,SessionHandler,ThreadLimitHandler
@ManagedObject("Jetty Handler")
public interface Handler
extends org.eclipse.jetty.util.component.LifeCycle, org.eclipse.jetty.util.component.Destroyable
A Jetty Server Handler.
A Handler instance is required by a Server to handle incoming
HTTP requests.
A Handler may:
- Completely generate the HTTP Response
- Examine/modify the request and call another Handler (see
HandlerWrapper). - Pass the request to one or more other Handlers (see
HandlerCollection).
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
org.eclipse.jetty.util.component.LifeCycle.Listener -
Method Summary
Modifier and TypeMethodDescriptionvoiddestroy()org.eclipse.jetty.server.Servervoidhandle(String target, Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle a request.voidsetServer(org.eclipse.jetty.server.Server server) Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle
addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop
-
Method Details
-
handle
void handle(String target, Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws IOException, javax.servlet.ServletException 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 theRequestobject or a wrapper of that request.response- The response as theResponseobject or a wrapper of that request.- Throws:
IOException- if unable to handle the request or response processingjavax.servlet.ServletException- if unable to handle the request or response due to underlying servlet issue
-
setServer
void setServer(org.eclipse.jetty.server.Server server) -
getServer
@ManagedAttribute(value="the jetty server for this handler", readonly=true) org.eclipse.jetty.server.Server getServer() -
destroy
@ManagedOperation(value="destroy associated resources", impact="ACTION") void destroy()- Specified by:
destroyin interfaceorg.eclipse.jetty.util.component.Destroyable
-