Package org.eclipse.jetty.client.api

Interface Request.Listener

All Superinterfaces:
EventListener, Request.BeginListener, Request.CommitListener, Request.ContentListener, Request.FailureListener, Request.HeadersListener, Request.QueuedListener, Request.RequestListener, Request.SuccessListener
All Known Implementing Classes:
Request.Listener.Adapter
Enclosing interface:
Request
public static interface Request.Listener extends Request.QueuedListener, Request.BeginListener, Request.HeadersListener, Request.CommitListener, Request.ContentListener, Request.SuccessListener, Request.FailureListener
Listener for all request events.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Request.Listener.Adapter
    An empty implementation of Request.Listener

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    onBegin(Request request)
    Callback method invoked when the request begins being processed in order to be sent.
    default void
    onCommit(Request request)
    Callback method invoked when the request headers (and perhaps small content) have been sent.
    default void
    onContent(Request request, ByteBuffer content)
    Callback method invoked when a chunk of request content has been sent successfully.
    default void
    onFailure(Request request, Throwable failure)
    Callback method invoked when the request has failed to be sent
    default void
    onHeaders(Request request)
    Callback method invoked when the request headers (and perhaps small content) are ready to be sent.
    default void
    onQueued(Request request)
    Callback method invoked when the request is queued, waiting to be sent
    default void
    onSuccess(Request request)
    Callback method invoked when the request has been successfully sent.

  • Method Details

    • onQueued

      default void onQueued(Request request)
      Description copied from interface: Request.QueuedListener
      Callback method invoked when the request is queued, waiting to be sent
      Specified by:
      onQueued in interface Request.QueuedListener
      Parameters:
      request - the request being queued

    • onBegin

      default void onBegin(Request request)
      Description copied from interface: Request.BeginListener
      Callback method invoked when the request begins being processed in order to be sent. This is the last opportunity to modify the request.
      Specified by:
      onBegin in interface Request.BeginListener
      Parameters:
      request - the request that begins being processed

    • onHeaders

      default void onHeaders(Request request)
      Description copied from interface: Request.HeadersListener
      Callback method invoked when the request headers (and perhaps small content) are ready to be sent. The request has been converted into bytes, but not yet sent to the server, and further modifications to the request may have no effect.
      Specified by:
      onHeaders in interface Request.HeadersListener
      Parameters:
      request - the request that is about to be committed

    • onCommit

      default void onCommit(Request request)
      Description copied from interface: Request.CommitListener
      Callback method invoked when the request headers (and perhaps small content) have been sent. The request is now committed, and in transit to the server, and further modifications to the request may have no effect.
      Specified by:
      onCommit in interface Request.CommitListener
      Parameters:
      request - the request that has been committed

    • onContent

      default void onContent(Request request, ByteBuffer content)
      Description copied from interface: Request.ContentListener
      Callback method invoked when a chunk of request content has been sent successfully. Changes to bytes in the given buffer have no effect, as the content has already been sent.
      Specified by:
      onContent in interface Request.ContentListener
      Parameters:
      request - the request that has been committed
      content - the content

    • onSuccess

      default void onSuccess(Request request)
      Description copied from interface: Request.SuccessListener
      Callback method invoked when the request has been successfully sent.
      Specified by:
      onSuccess in interface Request.SuccessListener
      Parameters:
      request - the request sent

    • onFailure

      default void onFailure(Request request, Throwable failure)
      Description copied from interface: Request.FailureListener
      Callback method invoked when the request has failed to be sent
      Specified by:
      onFailure in interface Request.FailureListener
      Parameters:
      request - the request that failed
      failure - the failure