Class BasicResponseConsumer<T>
java.lang.Object
org.apache.hc.core5.http.nio.support.BasicResponseConsumer<T>
- All Implemented Interfaces:
AsyncDataConsumer
,AsyncResponseConsumer<Message<HttpResponse,
,T>> ResourceHolder
public class BasicResponseConsumer<T>
extends Object
implements AsyncResponseConsumer<Message<HttpResponse,T>>
Basic implementation of
AsyncResponseConsumer
that represents response message as
a Message
and relies on a AsyncEntityConsumer
to process response entity
stream.- Since:
- 5.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final AtomicReference
<AsyncEntityConsumer<T>> private final Supplier
<AsyncEntityConsumer<T>> -
Constructor Summary
ConstructorsConstructorDescriptionBasicResponseConsumer
(Supplier<AsyncEntityConsumer<T>> dataConsumerSupplier) BasicResponseConsumer
(AsyncEntityConsumer<T> dataConsumer) -
Method Summary
Modifier and TypeMethodDescriptionvoid
consume
(ByteBuffer src) Triggered to pass incoming data to the data consumer.void
consumeResponse
(HttpResponse response, EntityDetails entityDetails, HttpContext httpContext, FutureCallback<Message<HttpResponse, T>> resultCallback) Triggered to signal receipt of a response message head.void
Triggered to signal a failure in data processing.void
informationResponse
(HttpResponse response, HttpContext httpContext) Triggered to signal receipt of an intermediate (1xx) HTTP response.void
void
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.
-
Field Details
-
dataConsumerSupplier
-
dataConsumerRef
-
-
Constructor Details
-
BasicResponseConsumer
-
BasicResponseConsumer
-
-
Method Details
-
consumeResponse
public void consumeResponse(HttpResponse response, EntityDetails entityDetails, HttpContext httpContext, FutureCallback<Message<HttpResponse, T>> resultCallback) throws HttpException, IOExceptionDescription 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
IOException
-
informationResponse
public void informationResponse(HttpResponse response, HttpContext httpContext) throws HttpException, IOException Description copied from interface:AsyncResponseConsumer
Triggered to signal receipt of an intermediate (1xx) HTTP response.- Specified by:
informationResponse
in interfaceAsyncResponseConsumer<T>
- Parameters:
response
- the intermediate (1xx) HTTP response.httpContext
- the actual execution context.- Throws:
HttpException
IOException
-
updateCapacity
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:
IOException
-
consume
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:
IOException
-
streamEnd
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
IOException
-
failed
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 void releaseResources()- Specified by:
releaseResources
in interfaceResourceHolder
-