Class PoolingHttpClientConnectionManagerBuilder

java.lang.Object

org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder

public class PoolingHttpClientConnectionManagerBuilder
extends Object

Builder for PoolingHttpClientConnectionManager 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 org.apache.hc.core5.http.io.HttpConnectionFactory<ManagedHttpClientConnection>	connectionFactory
private DnsResolver	dnsResolver
private int	maxConnPerRoute
private int	maxConnTotal
private boolean	offLockDisposalEnabled
private org.apache.hc.core5.pool.PoolConcurrencyPolicy	poolConcurrencyPolicy
private org.apache.hc.core5.pool.PoolReusePolicy	poolReusePolicy
private SchemePortResolver	schemePortResolver
private org.apache.hc.core5.function.Resolver<HttpRoute, org.apache.hc.core5.http.io.SocketConfig>	socketConfigResolver
private boolean	systemProperties
private org.apache.hc.core5.function.Resolver<org.apache.hc.core5.http.HttpHost, TlsConfig>	tlsConfigResolver
private TlsSocketStrategy	tlsSocketStrategy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PoolingHttpClientConnectionManagerBuilder()

Method Summary

Modifier and Type	Method	Description
PoolingHttpClientConnectionManager	build()
static PoolingHttpClientConnectionManagerBuilder	create()
protected HttpClientConnectionOperator	createConnectionOperator(SchemePortResolver schemePortResolver, DnsResolver dnsResolver, TlsSocketStrategy tlsSocketStrategy)
final PoolingHttpClientConnectionManagerBuilder	setConnectionConfigResolver(org.apache.hc.core5.function.Resolver<HttpRoute, ConnectionConfig> connectionConfigResolver)	Sets Resolver of ConnectionConfig on a per route basis.
final PoolingHttpClientConnectionManagerBuilder	setConnectionFactory(org.apache.hc.core5.http.io.HttpConnectionFactory<ManagedHttpClientConnection> connectionFactory)	Sets HttpConnectionFactory instance.
final PoolingHttpClientConnectionManagerBuilder	setConnectionTimeToLive(org.apache.hc.core5.util.TimeValue timeToLive)	Deprecated. Use setDefaultConnectionConfig(ConnectionConfig).
final PoolingHttpClientConnectionManagerBuilder	setConnPoolPolicy(org.apache.hc.core5.pool.PoolReusePolicy poolReusePolicy)	Sets PoolReusePolicy value.
final PoolingHttpClientConnectionManagerBuilder	setDefaultConnectionConfig(ConnectionConfig config)	Sets the same ConnectionConfig for all routes.
final PoolingHttpClientConnectionManagerBuilder	setDefaultSocketConfig(org.apache.hc.core5.http.io.SocketConfig config)	Sets the same SocketConfig for all routes.
final PoolingHttpClientConnectionManagerBuilder	setDefaultTlsConfig(TlsConfig config)	Sets the same TlsConfig for all hosts.
final PoolingHttpClientConnectionManagerBuilder	setDnsResolver(DnsResolver dnsResolver)	Sets DnsResolver instance.
final PoolingHttpClientConnectionManagerBuilder	setMaxConnPerRoute(int maxConnPerRoute)	Sets maximum connection per route value.
final PoolingHttpClientConnectionManagerBuilder	setMaxConnTotal(int maxConnTotal)	Sets maximum total connection value.
final PoolingHttpClientConnectionManagerBuilder	setOffLockDisposalEnabled(boolean enabled)	Enable/disable off-lock disposal.
final PoolingHttpClientConnectionManagerBuilder	setPoolConcurrencyPolicy(org.apache.hc.core5.pool.PoolConcurrencyPolicy poolConcurrencyPolicy)	Sets PoolConcurrencyPolicy value.
final PoolingHttpClientConnectionManagerBuilder	setSchemePortResolver(SchemePortResolver schemePortResolver)	Sets SchemePortResolver instance.
final PoolingHttpClientConnectionManagerBuilder	setSocketConfigResolver(org.apache.hc.core5.function.Resolver<HttpRoute, org.apache.hc.core5.http.io.SocketConfig> socketConfigResolver)	Sets Resolver of SocketConfig on a per route basis.
final PoolingHttpClientConnectionManagerBuilder	setSSLSocketFactory(LayeredConnectionSocketFactory sslSocketFactory)	Deprecated. Use setTlsSocketStrategy(TlsSocketStrategy)
final PoolingHttpClientConnectionManagerBuilder	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 PoolingHttpClientConnectionManagerBuilder	setTlsSocketStrategy(TlsSocketStrategy tlsSocketStrategy)	Sets TlsSocketStrategy instance.
final PoolingHttpClientConnectionManagerBuilder	setValidateAfterInactivity(org.apache.hc.core5.util.TimeValue validateAfterInactivity)	Deprecated. Use setDefaultConnectionConfig(ConnectionConfig).
final PoolingHttpClientConnectionManagerBuilder	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

connectionFactory

private org.apache.hc.core5.http.io.HttpConnectionFactory<ManagedHttpClientConnection> connectionFactory

tlsSocketStrategy

private TlsSocketStrategy tlsSocketStrategy

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

socketConfigResolver

private org.apache.hc.core5.function.Resolver<HttpRoute, org.apache.hc.core5.http.io.SocketConfig> socketConfigResolver

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

systemProperties

private boolean systemProperties

maxConnTotal

private int maxConnTotal

maxConnPerRoute

private int maxConnPerRoute

offLockDisposalEnabled

private boolean offLockDisposalEnabled

Constructor Details

PoolingHttpClientConnectionManagerBuilder

@Internal
protected PoolingHttpClientConnectionManagerBuilder()

Method Details

create

public static PoolingHttpClientConnectionManagerBuilder create()

setConnectionFactory

public final PoolingHttpClientConnectionManagerBuilder setConnectionFactory(org.apache.hc.core5.http.io.HttpConnectionFactory<ManagedHttpClientConnection> connectionFactory)

Sets HttpConnectionFactory instance.

Returns:

this instance.

setSSLSocketFactory

@Deprecated
public final PoolingHttpClientConnectionManagerBuilder setSSLSocketFactory(LayeredConnectionSocketFactory sslSocketFactory)

Deprecated.

Use setTlsSocketStrategy(TlsSocketStrategy)

Sets LayeredConnectionSocketFactory instance.

Returns:

this instance.

setTlsSocketStrategy

public final PoolingHttpClientConnectionManagerBuilder setTlsSocketStrategy(TlsSocketStrategy tlsSocketStrategy)

Sets TlsSocketStrategy instance.

Returns:

this instance.

setDnsResolver

public final PoolingHttpClientConnectionManagerBuilder setDnsResolver(DnsResolver dnsResolver)

Sets DnsResolver instance.

Returns:

this instance.

setSchemePortResolver

public final PoolingHttpClientConnectionManagerBuilder setSchemePortResolver(SchemePortResolver schemePortResolver)

Sets SchemePortResolver instance.

Returns:

this instance.

setPoolConcurrencyPolicy

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

Sets PoolConcurrencyPolicy value.

Returns:

this instance.

setConnPoolPolicy

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

Sets PoolReusePolicy value.

Returns:

this instance.

setMaxConnTotal

public final PoolingHttpClientConnectionManagerBuilder setMaxConnTotal(int maxConnTotal)

Sets maximum total connection value.

Returns:

this instance.

setMaxConnPerRoute

public final PoolingHttpClientConnectionManagerBuilder setMaxConnPerRoute(int maxConnPerRoute)

Sets maximum connection per route value.

Returns:

this instance.

setDefaultSocketConfig

public final PoolingHttpClientConnectionManagerBuilder setDefaultSocketConfig(org.apache.hc.core5.http.io.SocketConfig config)

Sets the same SocketConfig for all routes.

Returns:

this instance.

setSocketConfigResolver

public final PoolingHttpClientConnectionManagerBuilder setSocketConfigResolver(org.apache.hc.core5.function.Resolver<HttpRoute, org.apache.hc.core5.http.io.SocketConfig> socketConfigResolver)

Sets Resolver of SocketConfig on a per route basis.

Returns:

this instance.

Since:

5.2

setDefaultConnectionConfig

public final PoolingHttpClientConnectionManagerBuilder setDefaultConnectionConfig(ConnectionConfig config)

Sets the same ConnectionConfig for all routes.

Returns:

this instance.

Since:

5.2

setConnectionConfigResolver

public final PoolingHttpClientConnectionManagerBuilder 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 PoolingHttpClientConnectionManagerBuilder setDefaultTlsConfig(TlsConfig config)

Sets the same TlsConfig for all hosts.

Returns:

this instance.

Since:

5.2

setTlsConfigResolver

public final PoolingHttpClientConnectionManagerBuilder 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 PoolingHttpClientConnectionManagerBuilder 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 PoolingHttpClientConnectionManagerBuilder setValidateAfterInactivity(org.apache.hc.core5.util.TimeValue validateAfterInactivity)

Deprecated.

Use setDefaultConnectionConfig(ConnectionConfig).

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

Returns:

this instance.

useSystemProperties

public final PoolingHttpClientConnectionManagerBuilder useSystemProperties()

Use system properties when creating and configuring default implementations.

Returns:

this instance.

setOffLockDisposalEnabled

@Experimental
public final PoolingHttpClientConnectionManagerBuilder setOffLockDisposalEnabled(boolean enabled)

Enable/disable off-lock disposal.

Since:

5.6

createConnectionOperator

@Internal
protected HttpClientConnectionOperator createConnectionOperator(SchemePortResolver schemePortResolver,
 DnsResolver dnsResolver,
 TlsSocketStrategy tlsSocketStrategy)

build

public PoolingHttpClientConnectionManager build()