Apache HttpClient 5.3 · org.apache.hc.client5.http.impl.classic.FutureRequestExecutionService

Modifier and Type	Field and Description
private final AtomicBoolean	closed
private final ExecutorService	executorService
private final HttpClient	httpclient
private final FutureRequestExecutionMetrics	metrics

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	FutureRequestExecutionService(final HttpClient you should tune your httpclient instance to match your needs. You should align the max number of connections in the pool and the number of threads in the executor; it doesn't make sense to have more threads than connections and if you have less connections than threads, the threads will just end up blocking on getting a connection from the pool. httpclient, final ExecutorService any executorService will do here. E.g. `java.util.concurrent.Executors#newFixedThreadPool(int)` executorService) Create a new FutureRequestExecutionService.

public

FutureRequestExecutionService(final HttpClient

you should tune your httpclient instance to match your needs. You should align the max number of connections in the pool and the number of threads in the executor; it doesn't make sense to have more threads than connections and if you have less connections than threads, the threads will just end up blocking on getting a connection from the pool.

httpclient, final ExecutorService

any executorService will do here. E.g. java.util.concurrent.Executors#newFixedThreadPool(int)

executorService)

Create a new FutureRequestExecutionService.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public <T> FutureTask<T>	Returns: HttpAsyncClientFutureTask for the scheduled request. execute(final ClassicHttpRequest request to execute request, final HttpContext context, final HttpClientResponseHandler<T> handler that will process the response. HttpClientResponseHandler) Schedule a request for execution.
public <T> FutureTask<T>	Returns: HttpAsyncClientFutureTask for the scheduled request. execute(final ClassicHttpRequest request to execute request, final HttpContext optional context; use null if not needed. context, final HttpClientResponseHandler<T> handler that will process the response. HttpClientResponseHandler, final FutureCallback<T> callback handler that will be called when the request is scheduled, started, completed, failed, or cancelled. callback) Schedule a request for execution.
public FutureRequestExecutionMetrics	Returns: metrics gathered for this instance. metrics()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

closed	back to summary
private final AtomicBoolean closed

executorService	back to summary
private final ExecutorService executorService

httpclient	back to summary
private final HttpClient httpclient

metrics	back to summary
private final FutureRequestExecutionMetrics metrics

Constructor Detail

FutureRequestExecutionService back to summary

FutureRequestExecutionService	back to summary
public FutureRequestExecutionService(final HttpClient httpclient, final ExecutorService executorService) Create a new FutureRequestExecutionService. Parameters httpclient:HttpClient you should tune your httpclient instance to match your needs. You should align the max number of connections in the pool and the number of threads in the executor; it doesn't make sense to have more threads than connections and if you have less connections than threads, the threads will just end up blocking on getting a connection from the pool. executorService:ExecutorService any executorService will do here. E.g. `java.util.concurrent.Executors#newFixedThreadPool(int)`

public FutureRequestExecutionService(final HttpClient httpclient, final ExecutorService executorService)

Create a new FutureRequestExecutionService.

Parameters

httpclient:HttpClient: you should tune your httpclient instance to match your needs. You should align the max number of connections in the pool and the number of threads in the executor; it doesn't make sense to have more threads than connections and if you have less connections than threads, the threads will just end up blocking on getting a connection from the pool.
executorService:ExecutorService: any executorService will do here. E.g. java.util.concurrent.Executors#newFixedThreadPool(int)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

execute	back to summary
public <T> FutureTask<T> execute(final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler<T> HttpClientResponseHandler) Schedule a request for execution. Parameters request:ClassicHttpRequest request to execute HttpClientResponseHandler:HttpClientResponseHandler<T> handler that will process the response. Returns:FutureTask<T> HttpAsyncClientFutureTask for the scheduled request.

execute

back to summary

public <T> FutureTask<T> execute(final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler<T> HttpClientResponseHandler)

Schedule a request for execution.

Parameters

request:ClassicHttpRequest: request to execute
HttpClientResponseHandler:HttpClientResponseHandler<T>: handler that will process the response.

Returns:FutureTask<T>

HttpAsyncClientFutureTask for the scheduled request.

execute	back to summary
public <T> FutureTask<T> execute(final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler<T> HttpClientResponseHandler, final FutureCallback<T> callback) Schedule a request for execution. Parameters request:ClassicHttpRequest request to execute context:HttpContext optional context; use null if not needed. HttpClientResponseHandler:HttpClientResponseHandler<T> handler that will process the response. callback:FutureCallback<T> callback handler that will be called when the request is scheduled, started, completed, failed, or cancelled. Returns:FutureTask<T> HttpAsyncClientFutureTask for the scheduled request.

execute

back to summary

public <T> FutureTask<T> execute(final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler<T> HttpClientResponseHandler, final FutureCallback<T> callback)

Schedule a request for execution.

Parameters

request:ClassicHttpRequest: request to execute
context:HttpContext: optional context; use null if not needed.
HttpClientResponseHandler:HttpClientResponseHandler<T>: handler that will process the response.
callback:FutureCallback<T>: callback handler that will be called when the request is scheduled, started, completed, failed, or cancelled.

Returns:FutureTask<T>

HttpAsyncClientFutureTask for the scheduled request.

metrics	back to summary
public FutureRequestExecutionMetrics metrics() Returns:FutureRequestExecutionMetrics metrics gathered for this instance. See Also `FutureRequestExecutionMetrics`

public Class FutureRequestExecutionService

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail