Class AbstractClassicEntityConsumer<T>
java.lang.Object
org.apache.hc.core5.http.nio.support.classic.AbstractClassicEntityConsumer<T>
- Type Parameters:
T
- entity representation.
- All Implemented Interfaces:
AsyncDataConsumer
,AsyncEntityConsumer<T>
,ResourceHolder
public abstract class AbstractClassicEntityConsumer<T>
extends Object
implements AsyncEntityConsumer<T>
AsyncEntityConsumer
implementation that acts as a compatibility
layer for classic InputStream
based interfaces. Blocking input
processing is executed through an Executor
.- Since:
- 5.0
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final SharedInputBuffer
private final AtomicReference
<Exception> private final Executor
private final AtomicReference
<T> private final AtomicReference
<AbstractClassicEntityConsumer.State> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal void
consume
(ByteBuffer src) Triggered to pass incoming data to the data consumer.protected abstract T
consumeData
(ContentType contentType, InputStream inputStream) Processes entity data from the given stream.final void
Triggered to signal a failure in data processing.final T
Returns the result of entity processing when it becomes available ornull
if the entity is still being received.final Exception
void
final void
Triggered to signal termination of the data stream.final void
streamStart
(EntityDetails entityDetails, FutureCallback<T> resultCallback) Signals beginning of an incoming request entity stream.final void
updateCapacity
(CapacityChannel capacityChannel) Triggered to signal ability of the underlying data stream to receive data capacity update.
-
Field Details
-
executor
-
buffer
-
state
-
resultRef
-
exceptionRef
-
-
Constructor Details
-
AbstractClassicEntityConsumer
-
-
Method Details
-
consumeData
protected abstract T consumeData(ContentType contentType, InputStream inputStream) throws IOException Processes entity data from the given stream.- Parameters:
contentType
- the entity content typeinputStream
- the input stream- Returns:
- the result of entity processing.
- Throws:
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
-
streamStart
public final void streamStart(EntityDetails entityDetails, FutureCallback<T> resultCallback) throws HttpException, IOException Description copied from interface:AsyncEntityConsumer
Signals beginning of an incoming request entity stream.- Specified by:
streamStart
in interfaceAsyncEntityConsumer<T>
- Parameters:
entityDetails
- the details of the incoming message entity.resultCallback
- the result callback.- Throws:
HttpException
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:AsyncEntityConsumer
Triggered to signal a failure in data processing.- Specified by:
failed
in interfaceAsyncEntityConsumer<T>
- Parameters:
cause
- the cause of the failure.
-
getException
-
getContent
Description copied from interface:AsyncEntityConsumer
Returns the result of entity processing when it becomes available ornull
if the entity is still being received.- Specified by:
getContent
in interfaceAsyncEntityConsumer<T>
- Returns:
- the response processing result.
-
releaseResources
public void releaseResources()- Specified by:
releaseResources
in interfaceResourceHolder
-