org.apache.hc.client5.http.impl.async

Class MinimalHttpAsyncClient

java.lang.Object

org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient

org.apache.hc.client5.http.impl.async.MinimalHttpAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable, HttpAsyncClient

@Contract(threading=SAFE_CONDITIONAL)
public final class MinimalHttpAsyncClient
extends CloseableHttpAsyncClient

Minimal implementation of CloseableHttpAsyncClient. This client is optimized for HTTP/1.1 and HTTP/2 message transport and does not support advanced HTTP protocol functionality such as request execution via a proxy, state management, authentication and request redirects.

Concurrent message exchanges executed by this client will get assigned to separate connections leased from the connection pool.

Since:

5.0

Method Summary

Methods

Modifier and Type	Method and Description
void	awaitShutdown(org.apache.hc.core5.util.TimeValue waitTime)
void	close()
org.apache.hc.core5.concurrent.Cancellable	execute(org.apache.hc.core5.http.nio.AsyncClientExchangeHandler exchangeHandler)
org.apache.hc.core5.concurrent.Cancellable	execute(org.apache.hc.core5.http.nio.AsyncClientExchangeHandler exchangeHandler, org.apache.hc.core5.http.nio.HandlerFactory<org.apache.hc.core5.http.nio.AsyncPushConsumer> pushHandlerFactory, org.apache.hc.core5.http.protocol.HttpContext context)
<T> Future<T>	execute(org.apache.hc.core5.http.nio.AsyncRequestProducer requestProducer, org.apache.hc.core5.http.nio.AsyncResponseConsumer<T> responseConsumer, org.apache.hc.core5.http.nio.HandlerFactory<org.apache.hc.core5.http.nio.AsyncPushConsumer> pushHandlerFactory, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.concurrent.FutureCallback<T> callback) Initiates asynchronous HTTP request execution using the given context.
org.apache.hc.core5.reactor.IOReactorStatus	getStatus()
void	initiateShutdown()
Future<org.apache.hc.core5.http.nio.AsyncClientEndpoint>	lease(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.concurrent.FutureCallback<org.apache.hc.core5.http.nio.AsyncClientEndpoint> callback)
Future<org.apache.hc.core5.http.nio.AsyncClientEndpoint>	lease(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.concurrent.FutureCallback<org.apache.hc.core5.http.nio.AsyncClientEndpoint> callback)
void	register(String hostname, String uriPattern, org.apache.hc.core5.function.Supplier<org.apache.hc.core5.http.nio.AsyncPushConsumer> supplier)
void	shutdown(org.apache.hc.core5.io.CloseMode closeMode)
void	start()

Methods inherited from class org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient

execute, execute, execute, execute, register

Methods inherited from class java.lang.Object

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

Method Detail

lease

public final Future<org.apache.hc.core5.http.nio.AsyncClientEndpoint> lease(org.apache.hc.core5.http.HttpHost host,
                                                             org.apache.hc.core5.concurrent.FutureCallback<org.apache.hc.core5.http.nio.AsyncClientEndpoint> callback)

lease

public Future<org.apache.hc.core5.http.nio.AsyncClientEndpoint> lease(org.apache.hc.core5.http.HttpHost host,
                                                             org.apache.hc.core5.http.protocol.HttpContext context,
                                                             org.apache.hc.core5.concurrent.FutureCallback<org.apache.hc.core5.http.nio.AsyncClientEndpoint> callback)

execute

public org.apache.hc.core5.concurrent.Cancellable execute(org.apache.hc.core5.http.nio.AsyncClientExchangeHandler exchangeHandler,
                                                 org.apache.hc.core5.http.nio.HandlerFactory<org.apache.hc.core5.http.nio.AsyncPushConsumer> pushHandlerFactory,
                                                 org.apache.hc.core5.http.protocol.HttpContext context)

execute

public final <T> Future<T> execute(org.apache.hc.core5.http.nio.AsyncRequestProducer requestProducer,
                    org.apache.hc.core5.http.nio.AsyncResponseConsumer<T> responseConsumer,
                    org.apache.hc.core5.http.nio.HandlerFactory<org.apache.hc.core5.http.nio.AsyncPushConsumer> pushHandlerFactory,
                    org.apache.hc.core5.http.protocol.HttpContext context,
                    org.apache.hc.core5.concurrent.FutureCallback<T> callback)

Description copied from interface: HttpAsyncClient

Initiates asynchronous HTTP request execution using the given context.

The request producer passed to this method will be used to generate a request message and stream out its content without buffering it in memory. The response consumer passed to this method will be used to process a response message without buffering its content in memory.

Please note it may be unsafe to interact with the context instance while the request is still being executed.

Type Parameters:

T - the result type of request execution.

Parameters:

requestProducer - request producer callback.

responseConsumer - response consumer callback.

pushHandlerFactory - the push handler factory. Optional and may be null.

context - HTTP context. Optional and may be null.

callback - future callback. Optional and may be null.

Returns:

future representing pending completion of the operation.

execute

public final org.apache.hc.core5.concurrent.Cancellable execute(org.apache.hc.core5.http.nio.AsyncClientExchangeHandler exchangeHandler)

start

public final void start()

Specified by:

start in class CloseableHttpAsyncClient

register

public void register(String hostname,
            String uriPattern,
            org.apache.hc.core5.function.Supplier<org.apache.hc.core5.http.nio.AsyncPushConsumer> supplier)

Specified by:

register in class CloseableHttpAsyncClient

getStatus

public final org.apache.hc.core5.reactor.IOReactorStatus getStatus()

Specified by:

getStatus in class CloseableHttpAsyncClient

awaitShutdown

public final void awaitShutdown(org.apache.hc.core5.util.TimeValue waitTime)
                         throws InterruptedException

Specified by:

awaitShutdown in class CloseableHttpAsyncClient

Throws:

InterruptedException

initiateShutdown

public final void initiateShutdown()

Specified by:

initiateShutdown in class CloseableHttpAsyncClient

shutdown

public final void shutdown(org.apache.hc.core5.io.CloseMode closeMode)

Specified by:

shutdown in class CloseableHttpAsyncClient

close

public void close()