Class AbstractBinAsyncEntityConsumer<T>
- java.lang.Object
-
- org.apache.hc.core5.http.nio.entity.AbstractBinDataConsumer
-
- org.apache.hc.core5.http.nio.entity.AbstractBinAsyncEntityConsumer<T>
-
- Type Parameters:
T
- entity representation.
- All Implemented Interfaces:
AsyncDataConsumer
,AsyncEntityConsumer<T>
,ResourceHolder
- Direct Known Subclasses:
BasicAsyncEntityConsumer
public abstract class AbstractBinAsyncEntityConsumer<T> extends AbstractBinDataConsumer implements AsyncEntityConsumer<T>
Abstract binary entity content consumer.- Since:
- 5.0
-
-
Field Summary
Fields Modifier and Type Field Description private T
content
private FutureCallback<T>
resultCallback
-
Constructor Summary
Constructors Constructor Description AbstractBinAsyncEntityConsumer()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
completed()
Triggered to signal completion of data processing.void
failed(java.lang.Exception cause)
Triggered to signal a failure in data processing.protected abstract T
generateContent()
Triggered to generate entity representation.T
getContent()
Returns the result of entity processing when it becomes available ornull
if the entity is still being received.protected abstract void
streamStart(ContentType contentType)
Triggered to signal beginning of entity content stream.void
streamStart(EntityDetails entityDetails, FutureCallback<T> resultCallback)
Signals beginning of an incoming request entity stream.-
Methods inherited from class org.apache.hc.core5.http.nio.entity.AbstractBinDataConsumer
capacityIncrement, consume, data, streamEnd, updateCapacity
-
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.AsyncDataConsumer
consume, streamEnd, updateCapacity
-
Methods inherited from interface org.apache.hc.core5.http.nio.ResourceHolder
releaseResources
-
-
-
-
Field Detail
-
resultCallback
private volatile FutureCallback<T> resultCallback
-
content
private volatile T content
-
-
Method Detail
-
streamStart
protected abstract void streamStart(ContentType contentType) throws HttpException, java.io.IOException
Triggered to signal beginning of entity content stream.- Parameters:
contentType
- the entity content type- Throws:
HttpException
java.io.IOException
-
generateContent
protected abstract T generateContent() throws java.io.IOException
Triggered to generate entity representation.- Returns:
- the entity content
- Throws:
java.io.IOException
-
streamStart
public final void streamStart(EntityDetails entityDetails, FutureCallback<T> resultCallback) throws java.io.IOException, HttpException
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:
java.io.IOException
HttpException
-
completed
protected final void completed() throws java.io.IOException
Description copied from class:AbstractBinDataConsumer
Triggered to signal completion of data processing.- Specified by:
completed
in classAbstractBinDataConsumer
- Throws:
java.io.IOException
-
failed
public final void failed(java.lang.Exception cause)
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.
-
getContent
public final T 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.
-
-