org.apache.hc.client5.http.async.methods

Class AbstractCharPushConsumer

java.lang.Object

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

org.apache.hc.client5.http.async.methods.AbstractCharPushConsumer

All Implemented Interfaces:

AsyncDataConsumer, AsyncPushConsumer, ResourceHolder

public abstract class AbstractCharPushConsumer
extends AbstractCharDataConsumer
implements AsyncPushConsumer

Abstract push response consumer that processes response body data as a character stream.

Since:

5.0

Field Summary

Fields inherited from class org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer

DEF_BUF_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractCharPushConsumer()

Method Summary

Modifier and Type	Method and Description
void	consumePromise(HttpRequest promise, HttpResponse response, EntityDetails entityDetails, HttpContext context) Triggered to signal receipt of a request message head used as a promise and the corresponding pushed response.
void	failed(Exception cause) Triggered to signal a failure in data processing.
protected abstract void	start(HttpRequest promise, HttpResponse response, ContentType contentType) Triggered to signal the beginning of data processing.

Methods inherited from class org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer

capacityIncrement, completed, consume, data, setCharset, streamEnd, updateCapacity

Methods inherited from class java.lang.Object

clone, equals, 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

Constructor Detail

AbstractCharPushConsumer

public AbstractCharPushConsumer()

Method Detail

consumePromise

public final void consumePromise(HttpRequest promise,
                                 HttpResponse response,
                                 EntityDetails entityDetails,
                                 HttpContext context)
                          throws HttpException,
                                 IOException

Description copied from interface: AsyncPushConsumer

Triggered to signal receipt of a request message head used as a promise and the corresponding pushed response.

Specified by:

consumePromise in interface AsyncPushConsumer

Parameters:

promise - the request message head used as a promise.

response - the pushed response message.

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

context - the actual execution context.

Throws:

HttpException

IOException

failed

public void failed(Exception cause)

Description copied from interface: AsyncPushConsumer

Triggered to signal a failure in data processing.

Specified by:

failed in interface AsyncPushConsumer

Parameters:

cause - the cause of the failure.

start

protected abstract void start(HttpRequest promise,
                              HttpResponse response,
                              ContentType contentType)
                       throws HttpException,
                              IOException

Triggered to signal the beginning of data processing.

Parameters:

response - the response message head

contentType - the content type of the response body, or null if the response does not enclose a response entity.

Throws:

HttpException

IOException