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

Class AbstractCharResponseConsumer<T>

java.lang.Object

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

org.apache.hc.client5.http.async.methods.AbstractCharResponseConsumer<T>

Type Parameters:

T - response message representation.

All Implemented Interfaces:

AsyncDataConsumer, AsyncResponseConsumer<T>, ResourceHolder

public abstract class AbstractCharResponseConsumer<T>
extends AbstractCharDataConsumer
implements AsyncResponseConsumer<T>

Abstract 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
AbstractCharResponseConsumer()

Method Summary

Modifier and Type	Method and Description
protected abstract T	buildResult() Triggered to generate object that represents a result of response message processing.
protected void	completed() Triggered to signal completion of data processing.
void	consumeResponse(HttpResponse response, EntityDetails entityDetails, HttpContext context, FutureCallback<T> resultCallback) Triggered to signal receipt of a response message head.
void	failed(Exception cause) Triggered to signal a failure in data processing.
void	informationResponse(HttpResponse response, HttpContext context) Triggered to signal receipt of an intermediate (1xx) HTTP response.
protected abstract void	start(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, 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

AbstractCharResponseConsumer

public AbstractCharResponseConsumer()

Method Detail

buildResult

protected abstract T buildResult()
                          throws IOException

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

Returns:

the result of response processing.

Throws:

IOException

completed

protected final void completed()
                        throws IOException

Description copied from class: AbstractCharDataConsumer

Triggered to signal completion of data processing.

Specified by:

completed in class AbstractCharDataConsumer

Throws:

IOException

consumeResponse

public final void consumeResponse(HttpResponse response,
                                  EntityDetails entityDetails,
                                  HttpContext context,
                                  FutureCallback<T> resultCallback)
                           throws HttpException,
                                  IOException

Description copied from interface: AsyncResponseConsumer

Triggered to signal receipt of a response message head.

Specified by:

consumeResponse in interface AsyncResponseConsumer<T>

Parameters:

response - the response message head.

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

context - the actual execution context.

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

Throws:

HttpException

IOException

failed

public void failed(Exception cause)

Description copied from interface: AsyncResponseConsumer

Triggered to signal a failure in data processing.

Specified by:

failed in interface AsyncResponseConsumer<T>

Parameters:

cause - the cause of the failure.

informationResponse

public void informationResponse(HttpResponse response,
                                HttpContext context)
                         throws HttpException,
                                IOException

Description copied from interface: AsyncResponseConsumer

Triggered to signal receipt of an intermediate (1xx) HTTP response.

Specified by:

informationResponse in interface AsyncResponseConsumer<T>

Parameters:

response - the intermediate (1xx) HTTP response.

context - the actual execution context.

Throws:

HttpException

IOException

start

protected abstract void start(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