Class AbstractAsyncPushHandler<T>

java.lang.Object
org.apache.hc.core5.http.nio.support.AbstractAsyncPushHandler<T>
Type Parameters:
T - response message representation.
All Implemented Interfaces:
AsyncDataConsumer, AsyncPushConsumer, ResourceHolder

public abstract class AbstractAsyncPushHandler<T> extends Object implements AsyncPushConsumer
Abstract push response handler.
Since:
5.0
  • Field Details

  • Constructor Details

  • Method Details

    • handleResponse

      protected abstract void handleResponse(HttpRequest promise, T responseMessage) throws IOException, HttpException
      Triggered to handle the push message with the given promised request.
      Parameters:
      promise - the promised request message.
      responseMessage - the pushed response message.
      Throws:
      IOException
      HttpException
    • handleError

      protected void handleError(HttpRequest promise, Exception cause)
      Triggered to handle the exception thrown while processing a push response.
      Parameters:
      promise - the promised request message.
      cause - the cause of error.
    • consumePromise

      public final void consumePromise(HttpRequest promise, HttpResponse response, EntityDetails entityDetails, HttpContext httpContext) throws HttpException, IOException
      Description copied from interface: AsyncPushConsumer
      Triggered to signal receipt of a request message head used as a promise and the corresponding pushed response.
      Specified by:
      consumePromise in interface AsyncPushConsumer
      Parameters:
      promise - the request message head used as a promise.
      response - the pushed response message.
      entityDetails - the response entity details or null if the response does not enclose an entity.
      httpContext - the actual execution context.
      Throws:
      HttpException
      IOException
    • updateCapacity

      public final void updateCapacity(CapacityChannel capacityChannel) throws IOException
      Description copied from interface: AsyncDataConsumer
      Triggered to signal ability of the underlying data stream to receive data capacity update. The data consumer can choose to write data immediately inside the call or asynchronously at some later point.
      Specified by:
      updateCapacity in interface AsyncDataConsumer
      Parameters:
      capacityChannel - the channel for capacity updates.
      Throws:
      IOException
    • consume

      public final void consume(ByteBuffer src) throws IOException
      Description copied from interface: AsyncDataConsumer
      Triggered to pass incoming data to the data consumer. The consumer must consume the entire content of the data buffer. The consumer must stop incrementing its capacity on the capacity channel if it is unable to accept more data. Once the data consumer has handled accumulated data or allocated more intermediate storage it can update its capacity information on the capacity channel.
      Specified by:
      consume in interface AsyncDataConsumer
      Parameters:
      src - data source.
      Throws:
      IOException
    • streamEnd

      public final void streamEnd(List<? extends Header> trailers) throws HttpException, IOException
      Description copied from interface: AsyncDataConsumer
      Triggered to signal termination of the data stream.
      Specified by:
      streamEnd in interface AsyncDataConsumer
      Parameters:
      trailers - data stream trailers.
      Throws:
      HttpException
      IOException
    • failed

      public final void failed(Exception cause)
      Description copied from interface: AsyncPushConsumer
      Triggered to signal a failure in data processing.
      Specified by:
      failed in interface AsyncPushConsumer
      Parameters:
      cause - the cause of the failure.
    • releaseResources

      public final void releaseResources()
      Specified by:
      releaseResources in interface ResourceHolder