Top Description Fields Constructors Methods
org.apache.hc.core5.http.nio.support

public abstract Class AbstractAsyncPushHandler<T>

extends Object
implements AsyncPushConsumer
Class Inheritance
All Implemented Interfaces
org.apache.hc.core5.http.nio.AsyncPushConsumer, org.apache.hc.core5.http.nio.AsyncDataConsumer, org.apache.hc.core5.http.nio.ResourceHolder
Type Parameters
<T>
response message representation.
Imports
java.io.IOException, java.nio.ByteBuffer, java.util.List, org.apache.hc.core5.concurrent.FutureCallback, org.apache.hc.core5.http.EntityDetails, .Header, .HttpException, .HttpRequest, .HttpResponse, org.apache.hc.core5.http.nio.AsyncPushConsumer, .AsyncResponseConsumer, .CapacityChannel, org.apache.hc.core5.http.protocol.HttpContext, org.apache.hc.core5.util.Args

Abstract push response handler.
Since
5.0

Field Summary

Modifier and TypeField and Description
private final AsyncResponseConsumer<T>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public final void
consume(final ByteBuffer
data source.
src
)

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.consume.

Triggered to pass incoming data to the data consumer.
public final void
consumePromise(final HttpRequest
the request message head used as a promise.
promise
,
final HttpResponse
the pushed response message.
response
,
final EntityDetails
the response entity details or null if the response does not enclose an entity.
entityDetails
,
final HttpContext
the actual execution context.
httpContext
)

Implements org.apache.hc.core5.http.nio.AsyncPushConsumer.consumePromise.

Triggered to signal receipt of a request message head used as a promise and the corresponding pushed response.
public final void
failed(final Exception
the cause of the failure.
cause
)

Implements org.apache.hc.core5.http.nio.AsyncPushConsumer.failed.

Triggered to signal a failure in data processing.
protected void
handleError(final HttpRequest
the promised request message.
promise
,
final Exception
the cause of error.
cause
)

Triggered to handle the exception thrown while processing a push response.

protected abstract void
handleResponse(final HttpRequest
the promised request message.
promise
,
final T
the pushed response message.
responseMessage
)

Triggered to handle the push message with the given promised request.

public final void
public final void
streamEnd(final List<? extends Header>
data stream trailers.
trailers
)

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd.

Triggered to signal termination of the data stream.
public final void
updateCapacity(final CapacityChannel
the channel for capacity updates.
capacityChannel
)

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity.

Triggered to signal ability of the underlying data stream to receive data capacity update.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

responseConsumerback to summary
private final AsyncResponseConsumer<T> responseConsumer

Constructor Detail

AbstractAsyncPushHandlerback to summary
public AbstractAsyncPushHandler(final AsyncResponseConsumer<T> responseConsumer)

Method Detail

consumeback to summary
public final void consume(final ByteBuffer src) throws IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.consume.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.consume.

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.

Parameters
src:ByteBuffer

data source.

Annotations
@Override
consumePromiseback to summary
public final void consumePromise(final HttpRequest promise, final HttpResponse response, final EntityDetails entityDetails, final HttpContext httpContext) throws HttpException, IOException

Implements org.apache.hc.core5.http.nio.AsyncPushConsumer.consumePromise.

Doc from org.apache.hc.core5.http.nio.AsyncPushConsumer.consumePromise.

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

Parameters
promise:HttpRequest

the request message head used as a promise.

response:HttpResponse

the pushed response message.

entityDetails:EntityDetails

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

httpContext:HttpContext

the actual execution context.

Annotations
@Override
failedback to summary
public final void failed(final Exception cause)

Implements org.apache.hc.core5.http.nio.AsyncPushConsumer.failed.

Doc from org.apache.hc.core5.http.nio.AsyncPushConsumer.failed.

Triggered to signal a failure in data processing.

Parameters
cause:Exception

the cause of the failure.

Annotations
@Override
handleErrorback to summary
protected void handleError(final HttpRequest promise, final Exception cause)

Triggered to handle the exception thrown while processing a push response.

Parameters
promise:HttpRequest

the promised request message.

cause:Exception

the cause of error.

handleResponseback to summary
protected abstract void handleResponse(final HttpRequest promise, final T responseMessage) throws IOException, HttpException

Triggered to handle the push message with the given promised request.

Parameters
promise:HttpRequest

the promised request message.

responseMessage:T

the pushed response message.

releaseResourcesback to summary
public final void releaseResources()

Implements org.apache.hc.core5.http.nio.ResourceHolder.releaseResources.

Annotations
@Override
streamEndback to summary
public final void streamEnd(final List<? extends Header> trailers) throws HttpException, IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd.

Triggered to signal termination of the data stream.

Parameters
trailers:List<? extends Header>

data stream trailers.

Annotations
@Override
updateCapacityback to summary
public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity.

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.

Parameters
capacityChannel:CapacityChannel

the channel for capacity updates.

Annotations
@Override