Top Description Fields Constructors Methods
org.apache.hc.core5.http.nio.support

public abstract Class AbstractAsyncResponseConsumer<T, E>

extends Object
implements AsyncResponseConsumer<T>
Class Inheritance
All Implemented Interfaces
org.apache.hc.core5.http.nio.AsyncResponseConsumer, org.apache.hc.core5.http.nio.AsyncDataConsumer, org.apache.hc.core5.http.nio.ResourceHolder
Type Parameters
<T>
response processing result representation.
<E>
response entity representation.
Imports
java.io.IOException, java.nio.ByteBuffer, java.nio.charset.UnsupportedCharsetException, java.util.List, java.util.concurrent.atomic.AtomicReference, org.apache.hc.core5.concurrent.CallbackContribution, .FutureCallback, org.apache.hc.core5.function.Supplier, org.apache.hc.core5.http.ContentType, .EntityDetails, .Header, .HttpException, .HttpResponse, org.apache.hc.core5.http.nio.AsyncEntityConsumer, .AsyncResponseConsumer, .CapacityChannel, org.apache.hc.core5.http.protocol.HttpContext, org.apache.hc.core5.util.Args

Abstract asynchronous response consumer that makes use of AsyncEntityConsumer to process response message content.
Since
5.0

Field Summary

Modifier and TypeField and Description
private final AtomicReference<AsyncEntityConsumer<E>>
private final Supplier<AsyncEntityConsumer<E>>

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
protected abstract T

Returns:

the result of response processing.
buildResult
(HttpResponse
the response message.
response
,
E
the response entity.
entity
,
ContentType
the response content type.
contentType
)

Triggered to generate object that represents a result of response message processing.

public final void
consume(final ByteBuffer
data source.
src
)

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.consume.

Triggered to pass incoming data to the data consumer.
public final void
consumeResponse(final HttpResponse
the response message head.
response
,
final EntityDetails
the response entity details or null if the response does not enclose an entity.
entityDetails
,
final HttpContext
the actual execution context.
httpContext
,
final FutureCallback<T>
the result callback called when response processing has been completed successfully or unsuccessfully.
resultCallback
)

Implements org.apache.hc.core5.http.nio.AsyncResponseConsumer.consumeResponse.

Triggered to signal receipt of a response message head.
public final void
failed(final Exception
the cause of the failure.
cause
)

Implements org.apache.hc.core5.http.nio.AsyncResponseConsumer.failed.

Triggered to signal a failure in data processing.
public final void
public final void
streamEnd(final List<? extends Header>
data stream trailers.
trailers
)

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd.

Triggered to signal termination of the data stream.
public final void
updateCapacity(final CapacityChannel
the channel for capacity updates.
capacityChannel
)

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity.

Triggered to signal ability of the underlying data stream to receive data capacity update.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

dataConsumerRefback to summary
private final AtomicReference<AsyncEntityConsumer<E>> dataConsumerRef
dataConsumerSupplierback to summary
private final Supplier<AsyncEntityConsumer<E>> dataConsumerSupplier

Constructor Detail

AbstractAsyncResponseConsumerback to summary
public AbstractAsyncResponseConsumer(final Supplier<AsyncEntityConsumer<E>> dataConsumerSupplier)
AbstractAsyncResponseConsumerback to summary
public AbstractAsyncResponseConsumer(final AsyncEntityConsumer<E> dataConsumer)

Method Detail

buildResultback to summary
protected abstract T buildResult(HttpResponse response, E entity, ContentType contentType)

Triggered to generate object that represents a result of response message processing.

Parameters
response:HttpResponse

the response message.

entity:E

the response entity.

contentType:ContentType

the response content type.

Returns:T

the result of response processing.

consumeback to summary
public final void consume(final ByteBuffer src) throws IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.consume.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.consume.

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.

Parameters
src:ByteBuffer

data source.

Annotations
@Override
consumeResponseback to summary
public final void consumeResponse(final HttpResponse response, final EntityDetails entityDetails, final HttpContext httpContext, final FutureCallback<T> resultCallback) throws HttpException, IOException

Implements org.apache.hc.core5.http.nio.AsyncResponseConsumer.consumeResponse.

Doc from org.apache.hc.core5.http.nio.AsyncResponseConsumer.consumeResponse.

Triggered to signal receipt of a response message head.

Parameters
response:HttpResponse

the response message head.

entityDetails:EntityDetails

the response entity details or null if the response does not enclose an entity.

httpContext:HttpContext

the actual execution context.

resultCallback:FutureCallback<T>

the result callback called when response processing has been completed successfully or unsuccessfully.

Annotations
@Override
failedback to summary
public final void failed(final Exception cause)

Implements org.apache.hc.core5.http.nio.AsyncResponseConsumer.failed.

Doc from org.apache.hc.core5.http.nio.AsyncResponseConsumer.failed.

Triggered to signal a failure in data processing.

Parameters
cause:Exception

the cause of the failure.

Annotations
@Override
releaseResourcesback to summary
public final void releaseResources()

Implements org.apache.hc.core5.http.nio.ResourceHolder.releaseResources.

Annotations
@Override
streamEndback to summary
public final void streamEnd(final List<? extends Header> trailers) throws HttpException, IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd.

Triggered to signal termination of the data stream.

Parameters
trailers:List<? extends Header>

data stream trailers.

Annotations
@Override
updateCapacityback to summary
public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity.

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.

Parameters
capacityChannel:CapacityChannel

the channel for capacity updates.

Annotations
@Override