org.apache.hc.core5.http.nio.entity

类 DigestingEntityConsumer<T>

java.lang.Object

org.apache.hc.core5.http.nio.entity.DigestingEntityConsumer<T>

所有已实现的接口:

AsyncDataConsumer, AsyncEntityConsumer<T>, ResourceHolder

public class DigestingEntityConsumer<T>
extends Object
implements AsyncEntityConsumer<T>

AsyncEntityConsumer decorator that calculates a digest hash from the data stream content and keeps the list of trailers received with the data stream.

从以下版本开始:

5.0

构造器概要

构造器

构造器和说明
DigestingEntityConsumer(String algo, AsyncEntityConsumer<T> wrapped)

方法概要

限定符和类型	方法和说明
void	consume(ByteBuffer src) Triggered to pass incoming data to the data consumer.
void	failed(Exception cause) Triggered to signal a failure in data processing.
T	getContent() Returns the result of entity processing when it becomes available or null if the entity is still being received.
byte[]	getDigest() Returns digest hash.
List<Header>	getTrailers() List of trailers sent with the data stream.
void	releaseResources()
void	streamEnd(List<? extends Header> trailers) Triggered to signal termination of the data stream.
void	streamStart(EntityDetails entityDetails, FutureCallback<T> resultCallback) Signals beginning of an incoming request entity stream.
void	updateCapacity(CapacityChannel capacityChannel) Triggered to signal ability of the underlying data stream to receive data capacity update.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

DigestingEntityConsumer

public DigestingEntityConsumer(String algo,
                               AsyncEntityConsumer<T> wrapped)
                        throws NoSuchAlgorithmException

抛出:

NoSuchAlgorithmException

方法详细资料

streamStart

public void streamStart(EntityDetails entityDetails,
                        FutureCallback<T> resultCallback)
                 throws IOException,
                        HttpException

从接口复制的说明: AsyncEntityConsumer

Signals beginning of an incoming request entity stream.

指定者:

streamStart 在接口中 AsyncEntityConsumer<T>

参数:

entityDetails - the details of the incoming message entity.

resultCallback - the result callback.

抛出:

IOException

HttpException

updateCapacity

public void updateCapacity(CapacityChannel capacityChannel)
                    throws IOException

从接口复制的说明: 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.

指定者:

updateCapacity 在接口中 AsyncDataConsumer

参数:

capacityChannel - the channel for capacity updates.

抛出:

IOException

consume

public void consume(ByteBuffer src)
             throws IOException

从接口复制的说明: 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.

指定者:

consume 在接口中 AsyncDataConsumer

参数:

src - data source.

抛出:

IOException

streamEnd

public void streamEnd(List<? extends Header> trailers)
               throws HttpException,
                      IOException

从接口复制的说明: AsyncDataConsumer

Triggered to signal termination of the data stream.

指定者:

streamEnd 在接口中 AsyncDataConsumer

参数:

trailers - data stream trailers.

抛出:

HttpException

IOException

failed

public void failed(Exception cause)

从接口复制的说明: AsyncEntityConsumer

Triggered to signal a failure in data processing.

指定者:

failed 在接口中 AsyncEntityConsumer<T>

参数:

cause - the cause of the failure.

getContent

public T getContent()

从接口复制的说明: AsyncEntityConsumer

Returns the result of entity processing when it becomes available or null if the entity is still being received.

指定者:

getContent 在接口中 AsyncEntityConsumer<T>

返回:

the response processing result.

releaseResources

public void releaseResources()

指定者:

releaseResources 在接口中 ResourceHolder

getTrailers

public List<Header> getTrailers()

List of trailers sent with the data stream.

返回:

the list of trailers sent with the data stream

getDigest

public byte[] getDigest()

Returns digest hash.

返回:

the digest hash value.