Class DumpHandler

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.DumpHandler
All Implemented Interfaces:
Handler, Request.Handler, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, Invocable
@ManagedObject public class DumpHandler extends Handler.Abstract
Dumps GET and POST requests as HTML response content. Useful for testing and debugging. The following request query parameters are understood:
flush
A boolean parameter, which if true causes the response to be flushed before the content is generated
empty
A boolean parameter, which if true causes the response to be empty
read
An integer parameter, which if set causes a specific number of bytes of content to be read, else the entire content is read.
date
A String parameter, which if set is used as the value of a Date header in the response
ISE
A boolean parameter, which if true causes handling method to throw an IllegalStateException
error
An integer parameter, which if set is used as the response status code.

  • Constructor Details

    • DumpHandler

      public DumpHandler()

    • DumpHandler

      public DumpHandler(String label)

  • Method Details

    • getHandledCounter

      @ManagedAttribute("handled count") public CounterStatistic getHandledCounter()

    • 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: