Class PoolingAsyncClientConnectionManagerBuilder

java.lang.Object

org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder

public class PoolingAsyncClientConnectionManagerBuilder
extends Object

Builder for PoolingAsyncClientConnectionManager instances.

When a particular component is not explicitly set this class will use its default implementation. System properties will be taken into account when configuring the default implementations when useSystemProperties() method is called prior to calling build().

• ssl.TrustManagerFactory.algorithm
• javax.net.ssl.trustStoreType
• javax.net.ssl.trustStore
• javax.net.ssl.trustStoreProvider
• javax.net.ssl.trustStorePassword
• ssl.KeyManagerFactory.algorithm
• javax.net.ssl.keyStoreType
• javax.net.ssl.keyStore
• javax.net.ssl.keyStoreProvider
• javax.net.ssl.keyStorePassword
• https.protocols
• https.cipherSuites

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.hc.core5.function.Resolver<HttpRoute, ConnectionConfig>	connectionConfigResolver
private DnsResolver	dnsResolver
private int	maxConnPerRoute
private int	maxConnTotal
private boolean	messageMultiplexing
private org.apache.hc.core5.pool.PoolConcurrencyPolicy	poolConcurrencyPolicy
private org.apache.hc.core5.pool.PoolReusePolicy	poolReusePolicy
private SchemePortResolver	schemePortResolver
private boolean	systemProperties
private org.apache.hc.core5.function.Resolver<org.apache.hc.core5.http.HttpHost, TlsConfig>	tlsConfigResolver
private org.apache.hc.core5.http.nio.ssl.TlsStrategy	tlsStrategy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PoolingAsyncClientConnectionManagerBuilder()

Method Summary

Modifier and Type	Method	Description
PoolingAsyncClientConnectionManager	build()
static PoolingAsyncClientConnectionManagerBuilder	create()
protected AsyncClientConnectionOperator	createConnectionOperator(org.apache.hc.core5.http.nio.ssl.TlsStrategy tlsStrategy, SchemePortResolver schemePortResolver, DnsResolver dnsResolver)
final PoolingAsyncClientConnectionManagerBuilder	setConnectionConfigResolver(org.apache.hc.core5.function.Resolver<HttpRoute, ConnectionConfig> connectionConfigResolver)	Sets Resolver of ConnectionConfig on a per route basis.
final PoolingAsyncClientConnectionManagerBuilder	setConnectionTimeToLive(org.apache.hc.core5.util.TimeValue timeToLive)	Deprecated. Use setDefaultConnectionConfig(ConnectionConfig)
final PoolingAsyncClientConnectionManagerBuilder	setConnPoolPolicy(org.apache.hc.core5.pool.PoolReusePolicy poolReusePolicy)	Sets PoolReusePolicy value.
final PoolingAsyncClientConnectionManagerBuilder	setDefaultConnectionConfig(ConnectionConfig config)	Sets the same ConnectionConfig for all routes.
final PoolingAsyncClientConnectionManagerBuilder	setDefaultTlsConfig(TlsConfig config)	Sets the same TlsConfig for all hosts.
final PoolingAsyncClientConnectionManagerBuilder	setDnsResolver(DnsResolver dnsResolver)	Sets DnsResolver instance.
final PoolingAsyncClientConnectionManagerBuilder	setMaxConnPerRoute(int maxConnPerRoute)	Sets maximum connection per route value.
final PoolingAsyncClientConnectionManagerBuilder	setMaxConnTotal(int maxConnTotal)	Sets maximum total connection value.
final PoolingAsyncClientConnectionManagerBuilder	setMessageMultiplexing(boolean messageMultiplexing)	Use experimental connections pool implementation that acts as a caching facade in front of a standard connection pool and shares already leased connections to multiplex message exchanges over active HTTP/2 connections.
final PoolingAsyncClientConnectionManagerBuilder	setPoolConcurrencyPolicy(org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy)	Sets PoolConcurrencyPolicy value.
final PoolingAsyncClientConnectionManagerBuilder	setSchemePortResolver(SchemePortResolver schemePortResolver)	Sets SchemePortResolver instance.
final PoolingAsyncClientConnectionManagerBuilder	setTlsConfigResolver(org.apache.hc.core5.function.Resolver<org.apache.hc.core5.http.HttpHost, TlsConfig> tlsConfigResolver)	Sets Resolver of TlsConfig on a per host basis.
final PoolingAsyncClientConnectionManagerBuilder	setTlsStrategy(org.apache.hc.core5.http.nio.ssl.TlsStrategy tlsStrategy)	Sets TlsStrategy instance for TLS connections.
final PoolingAsyncClientConnectionManagerBuilder	setValidateAfterInactivity(org.apache.hc.core5.util.TimeValue validateAfterInactivity)	Deprecated. Use setConnectionConfigResolver(Resolver).
final PoolingAsyncClientConnectionManagerBuilder	useSystemProperties()	Use system properties when creating and configuring default implementations.

Methods inherited from class Object

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

Field Details

tlsStrategy

private org.apache.hc.core5.http.nio.ssl.TlsStrategy tlsStrategy

schemePortResolver

private SchemePortResolver schemePortResolver

dnsResolver

private DnsResolver dnsResolver

poolConcurrencyPolicy

private org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy

poolReusePolicy

private org.apache.hc.core5.pool.PoolReusePolicy poolReusePolicy

systemProperties

private boolean systemProperties

maxConnTotal

private int maxConnTotal

maxConnPerRoute

private int maxConnPerRoute

connectionConfigResolver

private org.apache.hc.core5.function.Resolver<HttpRoute, ConnectionConfig> connectionConfigResolver

tlsConfigResolver

private org.apache.hc.core5.function.Resolver<org.apache.hc.core5.http.HttpHost, TlsConfig> tlsConfigResolver

messageMultiplexing

private boolean messageMultiplexing

Constructor Details

PoolingAsyncClientConnectionManagerBuilder

@Internal
protected PoolingAsyncClientConnectionManagerBuilder()

Method Details

create

public static PoolingAsyncClientConnectionManagerBuilder create()

setTlsStrategy

public final PoolingAsyncClientConnectionManagerBuilder setTlsStrategy(org.apache.hc.core5.http.nio.ssl.TlsStrategy tlsStrategy)

Sets TlsStrategy instance for TLS connections.

Returns:

this instance.

setDnsResolver

public final PoolingAsyncClientConnectionManagerBuilder setDnsResolver(DnsResolver dnsResolver)

Sets DnsResolver instance.

Returns:

this instance.

setSchemePortResolver

public final PoolingAsyncClientConnectionManagerBuilder setSchemePortResolver(SchemePortResolver schemePortResolver)

Sets SchemePortResolver instance.

Returns:

this instance.

setPoolConcurrencyPolicy

public final PoolingAsyncClientConnectionManagerBuilder setPoolConcurrencyPolicy(org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy)

Sets PoolConcurrencyPolicy value.

Returns:

this instance.

setConnPoolPolicy

public final PoolingAsyncClientConnectionManagerBuilder setConnPoolPolicy(org.apache.hc.core5.pool.PoolReusePolicy poolReusePolicy)

Sets PoolReusePolicy value.

Returns:

this instance.

setMaxConnTotal

public final PoolingAsyncClientConnectionManagerBuilder setMaxConnTotal(int maxConnTotal)

Sets maximum total connection value.

Returns:

this instance.

setMaxConnPerRoute

public final PoolingAsyncClientConnectionManagerBuilder setMaxConnPerRoute(int maxConnPerRoute)

Sets maximum connection per route value.

Returns:

this instance.

setDefaultConnectionConfig

public final PoolingAsyncClientConnectionManagerBuilder setDefaultConnectionConfig(ConnectionConfig config)

Sets the same ConnectionConfig for all routes.

Returns:

this instance.

Since:

5.2

setConnectionConfigResolver

public final PoolingAsyncClientConnectionManagerBuilder setConnectionConfigResolver(org.apache.hc.core5.function.Resolver<HttpRoute, ConnectionConfig> connectionConfigResolver)

Sets Resolver of ConnectionConfig on a per route basis.

Returns:

this instance.

Since:

5.2

setDefaultTlsConfig

public final PoolingAsyncClientConnectionManagerBuilder setDefaultTlsConfig(TlsConfig config)

Sets the same TlsConfig for all hosts.

Returns:

this instance.

Since:

5.2

setTlsConfigResolver

public final PoolingAsyncClientConnectionManagerBuilder setTlsConfigResolver(org.apache.hc.core5.function.Resolver<org.apache.hc.core5.http.HttpHost, TlsConfig> tlsConfigResolver)

Sets Resolver of TlsConfig on a per host basis.

Returns:

this instance.

Since:

5.2

setConnectionTimeToLive

@Deprecated
public final PoolingAsyncClientConnectionManagerBuilder setConnectionTimeToLive(org.apache.hc.core5.util.TimeValue timeToLive)

Deprecated.

Use setDefaultConnectionConfig(ConnectionConfig)

Sets maximum time to live for persistent connections

Returns:

this instance.

setValidateAfterInactivity

@Deprecated
public final PoolingAsyncClientConnectionManagerBuilder setValidateAfterInactivity(org.apache.hc.core5.util.TimeValue validateAfterInactivity)

Deprecated.

Use setConnectionConfigResolver(Resolver).

Sets period after inactivity after which persistent connections must be checked to ensure they are still valid.

Returns:

this instance.

useSystemProperties

public final PoolingAsyncClientConnectionManagerBuilder useSystemProperties()

Use system properties when creating and configuring default implementations.

Returns:

this instance.

setMessageMultiplexing

@Experimental
public final PoolingAsyncClientConnectionManagerBuilder setMessageMultiplexing(boolean messageMultiplexing)

Use experimental connections pool implementation that acts as a caching facade in front of a standard connection pool and shares already leased connections to multiplex message exchanges over active HTTP/2 connections.

Please note this flag has no effect on HTTP/1.1 and HTTP/1.0 connections.

This feature is considered experimenal

Returns:

this instance.

Since:

5.5

createConnectionOperator

@Internal
protected AsyncClientConnectionOperator createConnectionOperator(org.apache.hc.core5.http.nio.ssl.TlsStrategy tlsStrategy,
 SchemePortResolver schemePortResolver,
 DnsResolver dnsResolver)

build

public PoolingAsyncClientConnectionManager build()