Class PoolingAsyncClientConnectionManager
- All Implemented Interfaces:
Closeable
,AutoCloseable
,AsyncClientConnectionManager
,org.apache.hc.core5.io.ModalCloseable
,org.apache.hc.core5.pool.ConnPoolControl<HttpRoute>
,org.apache.hc.core5.pool.ConnPoolStats<HttpRoute>
PoolingAsyncClientConnectionManager
maintains a pool of non-blocking
HttpConnection
s and is able to service
connection requests from multiple execution threads. Connections are pooled
on a per route basis. A request for a route which already the manager has
persistent connections for available in the pool will be services by leasing
a connection from the pool rather than creating a new connection.
PoolingAsyncClientConnectionManager
maintains a maximum limit
of connection on a per route basis and in total. Connection limits
can be adjusted using ConnPoolControl
methods.
Total time to live (TTL) set at construction time defines maximum life span of persistent connections regardless of their expiration setting. No persistent connection will be re-used past its TTL value.
- Since:
- 5.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final AtomicBoolean
private org.apache.hc.core5.function.Resolver
<HttpRoute, ConnectionConfig> private final AsyncClientConnectionOperator
static final int
static final int
private static final PrefixedIncrementingId
private static final org.slf4j.Logger
private final org.apache.hc.core5.pool.ManagedConnPool
<HttpRoute, ManagedAsyncClientConnection> private org.apache.hc.core5.function.Resolver
<org.apache.hc.core5.http.HttpHost, TlsConfig> -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
PoolingAsyncClientConnectionManager
(AsyncClientConnectionOperator connectionOperator, org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy, org.apache.hc.core5.pool.PoolReusePolicy poolReusePolicy, org.apache.hc.core5.util.TimeValue timeToLive) PoolingAsyncClientConnectionManager
(org.apache.hc.core5.http.config.Lookup<org.apache.hc.core5.http.nio.ssl.TlsStrategy> tlsStrategyLookup) PoolingAsyncClientConnectionManager
(org.apache.hc.core5.http.config.Lookup<org.apache.hc.core5.http.nio.ssl.TlsStrategy> tlsStrategyLookup, org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy, org.apache.hc.core5.pool.PoolReusePolicy poolReusePolicy, org.apache.hc.core5.util.TimeValue timeToLive) PoolingAsyncClientConnectionManager
(org.apache.hc.core5.http.config.Lookup<org.apache.hc.core5.http.nio.ssl.TlsStrategy> tlsStrategyLookup, org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy, org.apache.hc.core5.pool.PoolReusePolicy poolReusePolicy, org.apache.hc.core5.util.TimeValue timeToLive, SchemePortResolver schemePortResolver, DnsResolver dnsResolver) PoolingAsyncClientConnectionManager
(org.apache.hc.core5.http.config.Lookup<org.apache.hc.core5.http.nio.ssl.TlsStrategy> tlsStrategyLookup, org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy, org.apache.hc.core5.util.TimeValue timeToLive) protected
PoolingAsyncClientConnectionManager
(org.apache.hc.core5.pool.ManagedConnPool<HttpRoute, ManagedAsyncClientConnection> pool, AsyncClientConnectionOperator connectionOperator) -
Method Summary
Modifier and TypeMethodDescriptioncast
(AsyncConnectionEndpoint endpoint) void
close()
void
close
(org.apache.hc.core5.io.CloseMode closeMode) void
void
closeIdle
(org.apache.hc.core5.util.TimeValue idletime) (package private) void
closeIfExpired
(org.apache.hc.core5.pool.PoolEntry<HttpRoute, ManagedAsyncClientConnection> entry) connect
(AsyncConnectionEndpoint endpoint, org.apache.hc.core5.reactor.ConnectionInitiator connectionInitiator, org.apache.hc.core5.util.Timeout timeout, Object attachment, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.concurrent.FutureCallback<AsyncConnectionEndpoint> callback) Connects the endpoint to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies).int
int
getMaxPerRoute
(HttpRoute route) int
org.apache.hc.core5.pool.PoolStats
org.apache.hc.core5.pool.PoolStats
org.apache.hc.core5.util.TimeValue
Deprecated.(package private) boolean
isClosed()
Method that can be called to determine whether the connection manager has been shut down and is closed or not.lease
(String id, HttpRoute route, Object state, org.apache.hc.core5.util.Timeout requestTimeout, org.apache.hc.core5.concurrent.FutureCallback<AsyncConnectionEndpoint> callback) Returns aFuture
object which can be used to obtain anAsyncConnectionEndpoint
or to cancel the request by callingFuture.cancel(boolean)
.void
release
(AsyncConnectionEndpoint endpoint, Object state, org.apache.hc.core5.util.TimeValue keepAlive) Releases the endpoint back to the manager making it potentially re-usable by other consumers.private ConnectionConfig
resolveConnectionConfig
(HttpRoute route) private TlsConfig
resolveTlsConfig
(org.apache.hc.core5.http.HttpHost host, Object attachment) void
setConnectionConfigResolver
(org.apache.hc.core5.function.Resolver<HttpRoute, ConnectionConfig> connectionConfigResolver) SetsResolver
ofConnectionConfig
on a per route basis.void
Sets the sameConnectionConfig
for all routesvoid
setDefaultMaxPerRoute
(int max) void
setDefaultTlsConfig
(TlsConfig config) Sets the sameConnectionConfig
for all hostsvoid
setMaxPerRoute
(HttpRoute route, int max) void
setMaxTotal
(int max) void
setTlsConfigResolver
(org.apache.hc.core5.function.Resolver<org.apache.hc.core5.http.HttpHost, TlsConfig> tlsConfigResolver) SetsResolver
ofTlsConfig
on a per host basis.void
setValidateAfterInactivity
(org.apache.hc.core5.util.TimeValue validateAfterInactivity) Deprecated.void
upgrade
(AsyncConnectionEndpoint endpoint, Object attachment, org.apache.hc.core5.http.protocol.HttpContext context) Upgrades transport security of the given endpoint by using the TLS security protocol.void
upgrade
(AsyncConnectionEndpoint endpoint, Object attachment, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.concurrent.FutureCallback<AsyncConnectionEndpoint> callback) Upgrades transport security of the given endpoint by using the TLS security protocol.
-
Field Details
-
LOG
private static final org.slf4j.Logger LOG -
DEFAULT_MAX_TOTAL_CONNECTIONS
public static final int DEFAULT_MAX_TOTAL_CONNECTIONS- See Also:
-
DEFAULT_MAX_CONNECTIONS_PER_ROUTE
public static final int DEFAULT_MAX_CONNECTIONS_PER_ROUTE- See Also:
-
pool
-
connectionOperator
-
closed
-
connectionConfigResolver
private volatile org.apache.hc.core5.function.Resolver<HttpRoute,ConnectionConfig> connectionConfigResolver -
tlsConfigResolver
private volatile org.apache.hc.core5.function.Resolver<org.apache.hc.core5.http.HttpHost,TlsConfig> tlsConfigResolver -
INCREMENTING_ID
-
-
Constructor Details
-
PoolingAsyncClientConnectionManager
public PoolingAsyncClientConnectionManager() -
PoolingAsyncClientConnectionManager
public PoolingAsyncClientConnectionManager(org.apache.hc.core5.http.config.Lookup<org.apache.hc.core5.http.nio.ssl.TlsStrategy> tlsStrategyLookup) -
PoolingAsyncClientConnectionManager
public PoolingAsyncClientConnectionManager(org.apache.hc.core5.http.config.Lookup<org.apache.hc.core5.http.nio.ssl.TlsStrategy> tlsStrategyLookup, org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy, org.apache.hc.core5.util.TimeValue timeToLive) -
PoolingAsyncClientConnectionManager
public PoolingAsyncClientConnectionManager(org.apache.hc.core5.http.config.Lookup<org.apache.hc.core5.http.nio.ssl.TlsStrategy> tlsStrategyLookup, org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy, org.apache.hc.core5.pool.PoolReusePolicy poolReusePolicy, org.apache.hc.core5.util.TimeValue timeToLive) -
PoolingAsyncClientConnectionManager
public PoolingAsyncClientConnectionManager(org.apache.hc.core5.http.config.Lookup<org.apache.hc.core5.http.nio.ssl.TlsStrategy> tlsStrategyLookup, org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy, org.apache.hc.core5.pool.PoolReusePolicy poolReusePolicy, org.apache.hc.core5.util.TimeValue timeToLive, SchemePortResolver schemePortResolver, DnsResolver dnsResolver) -
PoolingAsyncClientConnectionManager
@Internal protected PoolingAsyncClientConnectionManager(AsyncClientConnectionOperator connectionOperator, org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy, org.apache.hc.core5.pool.PoolReusePolicy poolReusePolicy, org.apache.hc.core5.util.TimeValue timeToLive) -
PoolingAsyncClientConnectionManager
@Internal protected PoolingAsyncClientConnectionManager(org.apache.hc.core5.pool.ManagedConnPool<HttpRoute, ManagedAsyncClientConnection> pool, AsyncClientConnectionOperator connectionOperator)
-
-
Method Details
-
close
public void close()- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
-
close
public void close(org.apache.hc.core5.io.CloseMode closeMode) - Specified by:
close
in interfaceorg.apache.hc.core5.io.ModalCloseable
-
cast
private PoolingAsyncClientConnectionManager.InternalConnectionEndpoint cast(AsyncConnectionEndpoint endpoint) -
resolveConnectionConfig
-
resolveTlsConfig
-
lease
public Future<AsyncConnectionEndpoint> lease(String id, HttpRoute route, Object state, org.apache.hc.core5.util.Timeout requestTimeout, org.apache.hc.core5.concurrent.FutureCallback<AsyncConnectionEndpoint> callback) Description copied from interface:AsyncClientConnectionManager
Returns aFuture
object which can be used to obtain anAsyncConnectionEndpoint
or to cancel the request by callingFuture.cancel(boolean)
.Please note that newly allocated endpoints can be leased
disconnected
. The consumer of the endpoint is responsible for fully establishing the route to the endpoint target by callingAsyncClientConnectionManager.connect(AsyncConnectionEndpoint, ConnectionInitiator, Timeout, Object, HttpContext, FutureCallback)
in order to connect directly to the target or to the first proxy hop, and optionally callingAsyncClientConnectionManager.upgrade(AsyncConnectionEndpoint, Object, HttpContext)
method to upgrade the underlying transport to Transport Layer Security after having executed aCONNECT
method to all intermediate proxy hops.- Specified by:
lease
in interfaceAsyncClientConnectionManager
- Parameters:
id
- unique operation ID ornull
.route
- HTTP route of the requested connection.state
- expected state of the connection ornull
if the connection is not expected to carry any state.requestTimeout
- lease request timeout.callback
- result callback.
-
release
public void release(AsyncConnectionEndpoint endpoint, Object state, org.apache.hc.core5.util.TimeValue keepAlive) Description copied from interface:AsyncClientConnectionManager
Releases the endpoint back to the manager making it potentially re-usable by other consumers. Optionally, the maximum period of how long the manager should keep the connection alive can be defined usingvalidDuration
andtimeUnit
parameters.- Specified by:
release
in interfaceAsyncClientConnectionManager
- Parameters:
endpoint
- the managed endpoint.state
- the new connection state ofnull
if state-less.keepAlive
- the duration of time this connection is valid for reuse.
-
connect
public Future<AsyncConnectionEndpoint> connect(AsyncConnectionEndpoint endpoint, org.apache.hc.core5.reactor.ConnectionInitiator connectionInitiator, org.apache.hc.core5.util.Timeout timeout, Object attachment, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.concurrent.FutureCallback<AsyncConnectionEndpoint> callback) Description copied from interface:AsyncClientConnectionManager
Connects the endpoint to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies).- Specified by:
connect
in interfaceAsyncClientConnectionManager
- Parameters:
endpoint
- the managed endpoint.timeout
- connect timeout.attachment
- connect request attachment.context
- the actual HTTP context.callback
- result callback.
-
upgrade
public void upgrade(AsyncConnectionEndpoint endpoint, Object attachment, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.concurrent.FutureCallback<AsyncConnectionEndpoint> callback) Description copied from interface:AsyncClientConnectionManager
Upgrades transport security of the given endpoint by using the TLS security protocol.- Specified by:
upgrade
in interfaceAsyncClientConnectionManager
- Parameters:
endpoint
- the managed endpoint.attachment
- the attachment the upgrade attachment object.context
- the actual HTTP context.callback
- result callback.
-
upgrade
public void upgrade(AsyncConnectionEndpoint endpoint, Object attachment, org.apache.hc.core5.http.protocol.HttpContext context) Description copied from interface:AsyncClientConnectionManager
Upgrades transport security of the given endpoint by using the TLS security protocol.- Specified by:
upgrade
in interfaceAsyncClientConnectionManager
- Parameters:
endpoint
- the managed endpoint.attachment
- the attachment the upgrade attachment object.context
- the actual HTTP context.
-
getRoutes
- Specified by:
getRoutes
in interfaceorg.apache.hc.core5.pool.ConnPoolControl<HttpRoute>
-
setMaxTotal
public void setMaxTotal(int max) - Specified by:
setMaxTotal
in interfaceorg.apache.hc.core5.pool.ConnPoolControl<HttpRoute>
-
getMaxTotal
public int getMaxTotal()- Specified by:
getMaxTotal
in interfaceorg.apache.hc.core5.pool.ConnPoolControl<HttpRoute>
-
setDefaultMaxPerRoute
public void setDefaultMaxPerRoute(int max) - Specified by:
setDefaultMaxPerRoute
in interfaceorg.apache.hc.core5.pool.ConnPoolControl<HttpRoute>
-
getDefaultMaxPerRoute
public int getDefaultMaxPerRoute()- Specified by:
getDefaultMaxPerRoute
in interfaceorg.apache.hc.core5.pool.ConnPoolControl<HttpRoute>
-
setMaxPerRoute
- Specified by:
setMaxPerRoute
in interfaceorg.apache.hc.core5.pool.ConnPoolControl<HttpRoute>
-
getMaxPerRoute
- Specified by:
getMaxPerRoute
in interfaceorg.apache.hc.core5.pool.ConnPoolControl<HttpRoute>
-
closeIdle
public void closeIdle(org.apache.hc.core5.util.TimeValue idletime) - Specified by:
closeIdle
in interfaceorg.apache.hc.core5.pool.ConnPoolControl<HttpRoute>
-
closeExpired
public void closeExpired()- Specified by:
closeExpired
in interfaceorg.apache.hc.core5.pool.ConnPoolControl<HttpRoute>
-
getTotalStats
public org.apache.hc.core5.pool.PoolStats getTotalStats()- Specified by:
getTotalStats
in interfaceorg.apache.hc.core5.pool.ConnPoolStats<HttpRoute>
-
getStats
- Specified by:
getStats
in interfaceorg.apache.hc.core5.pool.ConnPoolStats<HttpRoute>
-
setDefaultConnectionConfig
Sets the sameConnectionConfig
for all routes- Since:
- 5.2
-
setConnectionConfigResolver
public void setConnectionConfigResolver(org.apache.hc.core5.function.Resolver<HttpRoute, ConnectionConfig> connectionConfigResolver) SetsResolver
ofConnectionConfig
on a per route basis.- Since:
- 5.2
-
setDefaultTlsConfig
Sets the sameConnectionConfig
for all hosts- Since:
- 5.2
-
setTlsConfigResolver
public void setTlsConfigResolver(org.apache.hc.core5.function.Resolver<org.apache.hc.core5.http.HttpHost, TlsConfig> tlsConfigResolver) SetsResolver
ofTlsConfig
on a per host basis.- Since:
- 5.2
-
closeIfExpired
void closeIfExpired(org.apache.hc.core5.pool.PoolEntry<HttpRoute, ManagedAsyncClientConnection> entry) -
getValidateAfterInactivity
Deprecated.Use customsetConnectionConfigResolver(Resolver)
-
setValidateAfterInactivity
@Deprecated public void setValidateAfterInactivity(org.apache.hc.core5.util.TimeValue validateAfterInactivity) Deprecated.Defines period of inactivity after which persistent connections must be re-validated prior to beinglease(String, HttpRoute, Object, Timeout, FutureCallback)
leased} to the consumer. Negative values passed to this method disable connection validation. This check helps detect connections that have become stale (half-closed) while kept inactive in the pool. -
isClosed
boolean isClosed()Method that can be called to determine whether the connection manager has been shut down and is closed or not.- Returns:
true
if the connection manager has been shut down and is closed, otherwise returnfalse
.
-
setConnectionConfigResolver(Resolver)