Class AbstractAsyncResponseConsumer<T,E>
- java.lang.Object
-
- org.apache.hc.core5.http.nio.support.AbstractAsyncResponseConsumer<T,E>
-
- Type Parameters:
T
- response processing result representation.E
- response entity representation.
- All Implemented Interfaces:
AsyncDataConsumer
,AsyncResponseConsumer<T>
,ResourceHolder
public abstract class AbstractAsyncResponseConsumer<T,E> extends java.lang.Object implements AsyncResponseConsumer<T>
Abstract asynchronous response consumer that makes use ofAsyncEntityConsumer
to process response message content.- Since:
- 5.0
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.concurrent.atomic.AtomicReference<AsyncEntityConsumer<E>>
dataConsumerRef
private Supplier<AsyncEntityConsumer<E>>
dataConsumerSupplier
-
Constructor Summary
Constructors Constructor Description AbstractAsyncResponseConsumer(Supplier<AsyncEntityConsumer<E>> dataConsumerSupplier)
AbstractAsyncResponseConsumer(AsyncEntityConsumer<E> dataConsumer)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract T
buildResult(HttpResponse response, E entity, ContentType contentType)
Triggered to generate object that represents a result of response message processing.void
consume(java.nio.ByteBuffer src)
Triggered to pass incoming data to the data consumer.void
consumeResponse(HttpResponse response, EntityDetails entityDetails, HttpContext httpContext, FutureCallback<T> resultCallback)
Triggered to signal receipt of a response message head.void
failed(java.lang.Exception cause)
Triggered to signal a failure in data processing.void
releaseResources()
void
streamEnd(java.util.List<? extends Header> trailers)
Triggered to signal termination of the data stream.void
updateCapacity(CapacityChannel capacityChannel)
Triggered to signal ability of the underlying data stream to receive data capacity update.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.hc.core5.http.nio.AsyncResponseConsumer
informationResponse
-
-
-
-
Field Detail
-
dataConsumerSupplier
private final Supplier<AsyncEntityConsumer<E>> dataConsumerSupplier
-
dataConsumerRef
private final java.util.concurrent.atomic.AtomicReference<AsyncEntityConsumer<E>> dataConsumerRef
-
-
Constructor Detail
-
AbstractAsyncResponseConsumer
public AbstractAsyncResponseConsumer(Supplier<AsyncEntityConsumer<E>> dataConsumerSupplier)
-
AbstractAsyncResponseConsumer
public AbstractAsyncResponseConsumer(AsyncEntityConsumer<E> dataConsumer)
-
-
Method Detail
-
buildResult
protected abstract T buildResult(HttpResponse response, E entity, ContentType contentType)
Triggered to generate object that represents a result of response message processing.- Parameters:
response
- the response message.entity
- the response entity.contentType
- the response content type.- Returns:
- the result of response processing.
-
consumeResponse
public final void consumeResponse(HttpResponse response, EntityDetails entityDetails, HttpContext httpContext, FutureCallback<T> resultCallback) throws HttpException, java.io.IOException
Description copied from interface:AsyncResponseConsumer
Triggered to signal receipt of a response message head.- Specified by:
consumeResponse
in interfaceAsyncResponseConsumer<T>
- Parameters:
response
- the response message head.entityDetails
- the response entity details ornull
if the response does not enclose an entity.httpContext
- the actual execution context.resultCallback
- the result callback called when response processing has been completed successfully or unsuccessfully.- Throws:
HttpException
java.io.IOException
-
updateCapacity
public final void updateCapacity(CapacityChannel capacityChannel) throws java.io.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 interfaceAsyncDataConsumer
- Parameters:
capacityChannel
- the channel for capacity updates.- Throws:
java.io.IOException
-
consume
public final void consume(java.nio.ByteBuffer src) throws java.io.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 interfaceAsyncDataConsumer
- Parameters:
src
- data source.- Throws:
java.io.IOException
-
streamEnd
public final void streamEnd(java.util.List<? extends Header> trailers) throws HttpException, java.io.IOException
Description copied from interface:AsyncDataConsumer
Triggered to signal termination of the data stream.- Specified by:
streamEnd
in interfaceAsyncDataConsumer
- Parameters:
trailers
- data stream trailers.- Throws:
HttpException
java.io.IOException
-
failed
public final void failed(java.lang.Exception cause)
Description copied from interface:AsyncResponseConsumer
Triggered to signal a failure in data processing.- Specified by:
failed
in interfaceAsyncResponseConsumer<T>
- Parameters:
cause
- the cause of the failure.
-
releaseResources
public final void releaseResources()
- Specified by:
releaseResources
in interfaceResourceHolder
-
-