Interface Handler

All Superinterfaces:
Destroyable, LifeCycle
All Known Implementing Classes:
AbstractHandler, AbstractHandler.ErrorDispatchHandler, AbstractHandlerContainer, AsyncDelayHandler, BufferedResponseHandler, ConstraintSecurityHandler, ContextHandler, DebugHandler, ErrorHandler, ErrorPageErrorHandler, FileBufferedResponseHandler, HandlerCollection, HandlerList, HandlerWrapper, HotSwapHandler, IdleTimeoutHandler, InetAccessHandler, ResourceHandler, ScopedHandler, SecuredRedirectHandler, SecurityHandler, ServletContextHandler, ServletHandler, SessionHandler, ThreadLimitHandler, WebAppContext

@ManagedObject("Jetty Handler") public interface Handler extends LifeCycle, 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).
Handlers are passed the servlet API request and response object, but are not Servlets. The servlet container is implemented by handlers for context, security, session and servlet that modify the request object before passing it to the next stage of handling.
  • 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 the Request object or a wrapper of that request.
      response - The response as the Response object or a wrapper of that request.
      Throws:
      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
    • setServer

      void setServer(Server server)
    • getServer

      @ManagedAttribute(value="the jetty server for this handler", readonly=true) Server getServer()
    • destroy

      @ManagedOperation(value="destroy associated resources", impact="ACTION") void destroy()
      Specified by:
      destroy in interface Destroyable