Package org.eclipse.jetty.server.handler

Class DefaultHandler

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.server.Handler.Abstract
org.eclipse.jetty.server.handler.DefaultHandler
All Implemented Interfaces:
Handler, Request.Handler, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, Invocable
public class DefaultHandler extends Handler.Abstract
Default Handler. This handle will deal with unhandled requests in the server. For requests for favicon.ico, the Jetty icon is served. For requests to '/' a 404 with a list of known contexts is served. For all other requests a normal 404 is served.

  • Constructor Details

    • DefaultHandler

      public DefaultHandler()

    • DefaultHandler

      public DefaultHandler(@Name("serveFavIcon") boolean serveFavIcon, @Name("showContexts") boolean showContexts)

  • Method Details

    • setServer

      public void setServer(Server server)
      Description copied from interface: Handler
      Set the Server to associate to this Handler.
      Specified by:
      setServer in interface Handler
      Overrides:
      setServer in class Handler.Abstract
      Parameters:
      server - the Server to associate to this Handler

    • handle

      public boolean handle(Request request, Response response, Callback callback) throws Exception
      Description copied from interface: Request.Handler

      Invoked to handle the passed HTTP request and response.

      The request is accepted by returning true, then handling must be concluded by completing the passed callback. The handling may be asynchronous, i.e. this method may return true and complete the given callback later, possibly from a different thread. If this method returns false, then the callback must not be invoked and any mutation on the response reversed.

      Exceptions thrown by this method may be subsequently handled by an error Request.Handler, if present, otherwise a default HTTP 500 error is generated and the callback completed while writing the error response.

      The simplest implementation is:

       public boolean handle(Request request, Response response, Callback callback)
 {
     callback.succeeded();
     return true;
 }

      A HelloWorld implementation is:

       public boolean handle(Request request, Response response, Callback callback)
 {
     response.write(true, ByteBuffer.wrap("Hello World\n".getBytes(StandardCharsets.UTF_8)), callback);
     return true;
 }
      Parameters:
      request - the HTTP request to handle
      response - the HTTP response to handle
      callback - the callback to complete when the handling is complete
      Returns:
      True if and only if the request will be handled, a response generated and the callback eventually called. This may occur within the scope of the call to this method, or asynchronously some time later. If false is returned, then this method must not generate a response, nor complete the callback.
      Throws:
      Exception - if there is a failure during the handling. Catchers cannot assume that the callback will be called and thus should attempt to complete the request as if a false had been returned.
      See Also:

    • isServeFavIcon

      @ManagedAttribute("True if the favicon.ico is served") public boolean isServeFavIcon()
      Returns:
      Returns true if the handle can server the jetty favicon.ico

    • setServeFavIcon

      public void setServeFavIcon(boolean serveFavIcon)
      Set true if the handle can server the jetty favicon.ico.
      Parameters:
      serveFavIcon - true if the handle can server the jetty favicon.ico

    • isShowContexts

      @ManagedAttribute("True if the contexts should be shown in the default 404 page") public boolean isShowContexts()

    • setShowContexts

      public void setShowContexts(boolean show)

    • toString

      public String toString()
      Overrides:
      toString in class AbstractLifeCycle