Interface Response.Listener

All Superinterfaces:
EventListener, Response.AsyncContentListener, Response.BeginListener, Response.CompleteListener, Response.ContentListener, Response.ContentSourceListener, Response.FailureListener, Response.HeaderListener, Response.HeadersListener, Response.ResponseListener, Response.SuccessListener
All Known Implementing Classes:
AbstractResponseListener, AsyncMiddleManServlet.ProxyResponseListener, AsyncMiddleManServlet.ProxyResponseListener, AsyncMiddleManServlet.ProxyResponseListener, AsyncMiddleManServlet.ProxyResponseListener, BufferingResponseListener, CompletableResponseListener, ContinueProtocolHandler.ContinueListener, InputStreamResponseListener, PathResponseListener, ProxyHandler.ProxyResponseListener, ProxyServlet.ProxyResponseListener, ProxyServlet.ProxyResponseListener, ProxyServlet.ProxyResponseListener, ProxyServlet.ProxyResponseListener, RedirectProtocolHandler, RetainingResponseListener
Enclosing interface:
Response
public static interface Response.Listener extends Response.BeginListener, Response.HeaderListener, Response.HeadersListener, Response.ContentListener, Response.SuccessListener, Response.FailureListener, Response.CompleteListener
Listener for all response events.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    onBegin(Response response)
    Callback method invoked when the response line containing HTTP version, HTTP status code and reason has been received and parsed.
    default void
    onComplete(Result result)
    Callback method invoked when the request and the response have been processed, either successfully or not.
    default void
    onContent(Response response, ByteBuffer content)
    Callback method invoked when the response content has been received, parsed and there is demand.
    default void
    onFailure(Response response, Throwable failure)
    Callback method invoked when the response has failed in the process of being received
    default boolean
    onHeader(Response response, HttpField field)
    Callback method invoked when a response header has been received and parsed, returning whether the header should be processed or not.
    default void
    onHeaders(Response response)
    Callback method invoked when all the response headers have been received and parsed.
    default void
    onSuccess(Response response)
    Callback method invoked when the whole response has been successfully received.

    Methods inherited from interface Response.AsyncContentListener

    onContentSource

    Methods inherited from interface Response.ContentListener

    onContent

  • Method Details

    • onBegin

      default void onBegin(Response response)
      Description copied from interface: Response.BeginListener
      Callback method invoked when the response line containing HTTP version, HTTP status code and reason has been received and parsed.

      This method is the best approximation to detect when the first bytes of the response arrived to the client.

      Specified by:
      onBegin in interface Response.BeginListener
      Parameters:
      response - the response containing the response line data

    • onHeader

      default boolean onHeader(Response response, HttpField field)
      Description copied from interface: Response.HeaderListener
      Callback method invoked when a response header has been received and parsed, returning whether the header should be processed or not.
      Specified by:
      onHeader in interface Response.HeaderListener
      Parameters:
      response - the response containing the response line data and the headers so far
      field - the header received
      Returns:
      true to process the header, false to skip processing of the header

    • onHeaders

      default void onHeaders(Response response)
      Description copied from interface: Response.HeadersListener
      Callback method invoked when all the response headers have been received and parsed.
      Specified by:
      onHeaders in interface Response.HeadersListener
      Parameters:
      response - the response containing the response line data and the headers

    • onContent

      default void onContent(Response response, ByteBuffer content)
      Description copied from interface: Response.ContentListener
      Callback method invoked when the response content has been received, parsed and there is demand. This method may be invoked multiple times, and the content buffer must be consumed (or copied) before returning from this method. This method is also always invoked when content arrives as demand is automatically registered on return.
      Specified by:
      onContent in interface Response.ContentListener
      Parameters:
      response - the response containing the response line data and the headers
      content - the content bytes received

    • onSuccess

      default void onSuccess(Response response)
      Description copied from interface: Response.SuccessListener
      Callback method invoked when the whole response has been successfully received.
      Specified by:
      onSuccess in interface Response.SuccessListener
      Parameters:
      response - the response containing the response line data and the headers

    • onFailure

      default void onFailure(Response response, Throwable failure)
      Description copied from interface: Response.FailureListener
      Callback method invoked when the response has failed in the process of being received
      Specified by:
      onFailure in interface Response.FailureListener
      Parameters:
      response - the response containing data up to the point the failure happened
      failure - the failure happened

    • onComplete

      default void onComplete(Result result)
      Description copied from interface: Response.CompleteListener
      Callback method invoked when the request and the response have been processed, either successfully or not.

      The result parameter contains the request, the response, and eventual failures.

      Requests may complete after response, for example in case of big uploads that are discarded or read asynchronously by the server. This method is always invoked after Response.SuccessListener.onSuccess(Response) or Response.FailureListener.onFailure(Response, Throwable), and only when request indicates that it is completed.

      Specified by:
      onComplete in interface Response.CompleteListener
      Parameters:
      result - the result of the request / response exchange