Class AbstractClassicServerExchangeHandler

java.lang.Object
org.apache.hc.core5.http.nio.support.classic.AbstractClassicServerExchangeHandler
All Implemented Interfaces:
AsyncDataConsumer, AsyncDataExchangeHandler, AsyncDataProducer, AsyncServerExchangeHandler, ResourceHolder
@Deprecated public abstract class AbstractClassicServerExchangeHandler extends Object implements AsyncServerExchangeHandler
Deprecated.
Use ClassicToAsyncServerExchangeHandler.
AsyncServerExchangeHandler implementation that acts as a compatibility layer for classic InputStream / OutputStream based interfaces. Blocking input / output processing is executed through an Executor.
Since:
5.0

  • Field Details

  • Constructor Details

    • AbstractClassicServerExchangeHandler

      public AbstractClassicServerExchangeHandler(int initialBufferSize, Executor executor)
      Deprecated.

  • Method Details

    • handle

      protected abstract void handle(HttpRequest request, InputStream requestStream, HttpResponse response, OutputStream responseStream, HttpContext context) throws IOException, HttpException
      Deprecated.
      Handles an incoming request optionally reading its entity content form the given input stream and generates a response optionally writing out its entity content into the given output stream.
      Parameters:
      request - the incoming request
      requestStream - the request stream if the request encloses an entity, null otherwise.
      response - the outgoing response.
      responseStream - the response entity output stream.
      context - the actual execution context.
      Throws:
      IOException - in case of an I/O error.
      HttpException - in case of an HTTP protocol violation.

    • getException

      public Exception getException()
      Deprecated.

    • handleRequest

      public final void handleRequest(HttpRequest request, EntityDetails entityDetails, ResponseChannel responseChannel, HttpContext context) throws HttpException, IOException
      Deprecated.
      Description copied from interface: AsyncServerExchangeHandler
      Processes the actual HTTP request. The handler can choose to send response messages immediately inside the call or asynchronously at some later point.
      Specified by:
      handleRequest in interface AsyncServerExchangeHandler
      Parameters:
      request - the actual request.
      entityDetails - the request entity details or null if the request does not enclose an entity.
      responseChannel - the response channel.
      context - the actual execution context.
      Throws:
      HttpException - in case of an HTTP protocol violation.
      IOException - in case of an I/O error.

    • updateCapacity

      public final void updateCapacity(CapacityChannel capacityChannel) throws IOException
      Deprecated.
      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 - in case of an I/O error.

    • consume

      public final void consume(ByteBuffer src) throws IOException
      Deprecated.
      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 - in case of an I/O error.

    • streamEnd

      public final void streamEnd(List<? extends Header> trailers) throws HttpException, IOException
      Deprecated.
      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 - in case of an HTTP protocol violation.
      IOException - in case of an I/O error.

    • available

      public final int available()
      Deprecated.
      Description copied from interface: AsyncDataProducer
      Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.

      Please note this method should return zero if the data producer is unable to produce any more data, in which case AsyncDataProducer.produce(DataStreamChannel) method will not get triggered. The producer can resume writing out data asynchronously once more data becomes available or request output readiness events with DataStreamChannel.requestOutput().

      Specified by:
      available in interface AsyncDataProducer
      Returns:
      the number of bytes immediately available for output
      See Also:

    • produce

      public final void produce(DataStreamChannel channel) throws IOException
      Deprecated.
      Description copied from interface: AsyncDataProducer
      Triggered to signal the ability of the underlying data channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.

      Please note this method gets triggered only if AsyncDataProducer.available() returns a positive value.

      Specified by:
      produce in interface AsyncDataProducer
      Parameters:
      channel - the data channel capable of accepting more data.
      Throws:
      IOException - in case of an I/O error.
      See Also:

    • failed

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

    • releaseResources

      public void releaseResources()
      Deprecated.
      Specified by:
      releaseResources in interface ResourceHolder