Modifier and Type	Class and Description
pack-priv class	BasicHttpClientConnectionManager.InternalConnectionEndpoint

Modifier and Type	Field and Description
private final AtomicBoolean	closed
private ManagedHttpClientConnection	conn
private ConnectionConfig	connectionConfig
private final HttpClientConnectionOperator	connectionOperator
private final HttpConnectionFactory<ManagedHttpClientConnection>	connFactory
private static final AtomicLong	COUNT
private long	created
private long	expiry
private final String	id
private boolean	leased
private static final Logger	LOG
private HttpRoute	route
private SocketConfig	socketConfig
private Object	state
private TlsConfig	tlsConfig
private long	updated

Access	Constructor and Description
public	BasicHttpClientConnectionManager(final Lookup<ConnectionSocketFactory> socketFactoryRegistry, final HttpConnectionFactory<ManagedHttpClientConnection> connFactory, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver)
public	BasicHttpClientConnectionManager(final HttpClientConnectionOperator httpClientConnectionOperator, final HttpConnectionFactory<ManagedHttpClientConnection> connFactory)
public	BasicHttpClientConnectionManager(final Lookup<ConnectionSocketFactory> socketFactoryRegistry, final HttpConnectionFactory<ManagedHttpClientConnection> connFactory)
public	BasicHttpClientConnectionManager(final Lookup<ConnectionSocketFactory> socketFactoryRegistry)
public	BasicHttpClientConnectionManager()

Method Summary

Modifier and Type	Method and Description
private BasicHttpClientConnectionManager.InternalConnectionEndpoint	cast(final ConnectionEndpoint endpoint)
private void	checkExpiry()
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public void	close(final CloseMode How to close the receiver. closeMode) Implements org.apache.hc.core5.io.ModalCloseable.close. Closes this process or endpoint and releases any system resources associated with it.
private synchronized void	closeConnection(final CloseMode closeMode)
public synchronized void	closeExpired()
public synchronized void	closeIdle(final TimeValue idleTime)
public synchronized void	connect(final ConnectionEndpoint the managed endpoint. endpoint, final TimeValue connect timeout. timeout, final HttpContext the actual HTTP context. context) Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.connect. 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).
pack-priv synchronized ManagedHttpClientConnection	getConnection(final HttpRoute route, final Object state)
public synchronized ConnectionConfig	getConnectionConfig()
private static Registry<ConnectionSocketFactory>	getDefaultRegistry()
pack-priv HttpRoute	getRoute()
public synchronized SocketConfig	getSocketConfig()
pack-priv Object	getState()
public synchronized TlsConfig	getTlsConfig()
public TimeValue	getValidateAfterInactivity() Deprecated Use `getConnectionConfig()`
pack-priv boolean	Returns: `true` if the connection manager has been shut down and is closed, otherwise return `false`. isClosed() Method that can be called to determine whether the connection manager has been shut down and is closed or not.
public LeaseRequest	lease(final String id, final HttpRoute route, final Object state)
public LeaseRequest	lease(final String unique operation ID or `null`. id, final HttpRoute HTTP route of the requested connection. route, final Timeout lease request timeout. requestTimeout, final Object expected state of the connection or `null` if the connection is not expected to carry any state. state) Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.lease. Returns a `LeaseRequest` object which can be used to obtain a `ConnectionEndpoint` to cancel the request by calling `LeaseRequest#cancel()`.
public synchronized void	release(final ConnectionEndpoint the managed endpoint. endpoint, final Object the new connection state of `null` if state-less. state, final TimeValue the duration of time this connection is valid for reuse. keepAlive) Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.release. Releases the endpoint back to the manager making it potentially re-usable by other consumers.
public synchronized void	setConnectionConfig(final ConnectionConfig connectionConfig)
public synchronized void	setSocketConfig(final SocketConfig socketConfig)
public synchronized void	setTlsConfig(final TlsConfig tlsConfig)
public void	setValidateAfterInactivity(final TimeValue validateAfterInactivity) Deprecated Use `setConnectionConfig(ConnectionConfig)` Defines period of inactivity after which persistent connections must be re-validated prior to being `lease(String, HttpRoute, Object)` leased} to the consumer.
public synchronized void	upgrade(final ConnectionEndpoint the managed endpoint. endpoint, final HttpContext the actual HTTP context. context) Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.upgrade. Upgrades transport security of the given endpoint by using the TLS security protocol.
private void	validate()

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

conn	back to summary
private ManagedHttpClientConnection conn

connectionConfig	back to summary
private ConnectionConfig connectionConfig

connectionOperator	back to summary
private final HttpClientConnectionOperator connectionOperator

connFactory	back to summary
private final HttpConnectionFactory<ManagedHttpClientConnection> connFactory

COUNT	back to summary
private static final AtomicLong COUNT

created	back to summary
private long created

expiry	back to summary
private long expiry

id	back to summary
private final String id

leased	back to summary
private boolean leased

LOG	back to summary
private static final Logger LOG

route	back to summary
private HttpRoute route

socketConfig	back to summary
private SocketConfig socketConfig

state	back to summary
private Object state

tlsConfig	back to summary
private TlsConfig tlsConfig

updated	back to summary
private long updated

Constructor Detail

BasicHttpClientConnectionManager	back to summary
public BasicHttpClientConnectionManager(final Lookup<ConnectionSocketFactory> socketFactoryRegistry, final HttpConnectionFactory<ManagedHttpClientConnection> connFactory, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver)

BasicHttpClientConnectionManager	back to summary
public BasicHttpClientConnectionManager(final HttpClientConnectionOperator httpClientConnectionOperator, final HttpConnectionFactory<ManagedHttpClientConnection> connFactory) Since 4.4

BasicHttpClientConnectionManager	back to summary
public BasicHttpClientConnectionManager(final Lookup<ConnectionSocketFactory> socketFactoryRegistry, final HttpConnectionFactory<ManagedHttpClientConnection> connFactory)

BasicHttpClientConnectionManager	back to summary
public BasicHttpClientConnectionManager(final Lookup<ConnectionSocketFactory> socketFactoryRegistry)

BasicHttpClientConnectionManager	back to summary
public BasicHttpClientConnectionManager()

Method Detail

cast	back to summary
private BasicHttpClientConnectionManager.InternalConnectionEndpoint cast(final ConnectionEndpoint endpoint)

checkExpiry	back to summary
private void checkExpiry()

close back to summary

close	back to summary
public void close() 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

public void close()

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

close	back to summary
public void close(final CloseMode closeMode) Implements org.apache.hc.core5.io.ModalCloseable.close. Doc from org.apache.hc.core5.io.ModalCloseable.close. Closes this process or endpoint and releases any system resources associated with it. If the endpoint or the process is already closed then invoking this method has no effect. Parameters closeMode:CloseMode How to close the receiver. Annotations @Override

back to summary

public void close(final CloseMode closeMode)

Implements org.apache.hc.core5.io.ModalCloseable.close.

Doc from org.apache.hc.core5.io.ModalCloseable.close.

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

Parameters

closeMode:CloseMode: How to close the receiver.

Annotations

@Override

closeConnection	back to summary
private synchronized void closeConnection(final CloseMode closeMode)

closeExpired	back to summary
public synchronized void closeExpired()

closeIdle	back to summary
public synchronized void closeIdle(final TimeValue idleTime)

connect	back to summary
public synchronized void connect(final ConnectionEndpoint endpoint, final TimeValue timeout, final HttpContext context) throws IOException Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.connect. Doc from org.apache.hc.client5.http.io.HttpClientConnectionManager.connect. 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). Parameters endpoint:ConnectionEndpoint the managed endpoint. timeout:TimeValue connect timeout. context:HttpContext the actual HTTP context. Annotations @Override

connect

back to summary

public synchronized void connect(final ConnectionEndpoint endpoint, final TimeValue timeout, final HttpContext context) throws IOException

Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.connect.

Doc from org.apache.hc.client5.http.io.HttpClientConnectionManager.connect.

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).

Parameters

endpoint:ConnectionEndpoint: the managed endpoint.
timeout:TimeValue: connect timeout.
context:HttpContext: the actual HTTP context.

Annotations

@Override

getConnection	back to summary
pack-priv synchronized ManagedHttpClientConnection getConnection(final HttpRoute route, final Object state) throws IOException

getConnectionConfig	back to summary
public synchronized ConnectionConfig getConnectionConfig() Since 5.2

getDefaultRegistry	back to summary
private static Registry<ConnectionSocketFactory> getDefaultRegistry()

getRoute	back to summary
pack-priv HttpRoute getRoute()

getSocketConfig	back to summary
public synchronized SocketConfig getSocketConfig()

getState	back to summary
pack-priv Object getState()

getTlsConfig	back to summary
public synchronized TlsConfig getTlsConfig() Since 5.2

getValidateAfterInactivity	back to summary
public TimeValue getValidateAfterInactivity() Deprecated Use `getConnectionConfig()` Annotations @Deprecated Since 5.1 See Also `setValidateAfterInactivity(TimeValue)`

isClosed back to summary

isClosed	back to summary
pack-priv boolean isClosed() Method that can be called to determine whether the connection manager has been shut down and is closed or not. Returns:boolean `true` if the connection manager has been shut down and is closed, otherwise return `false`.

pack-priv boolean isClosed()

Method that can be called to determine whether the connection manager has been shut down and is closed or not.

Returns:boolean: true if the connection manager has been shut down and is closed, otherwise return false.

lease	back to summary
public LeaseRequest lease(final String id, final HttpRoute route, final Object state)

lease back to summary

lease	back to summary
public LeaseRequest lease(final String id, final HttpRoute route, final Timeout requestTimeout, final Object state) Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.lease. Doc from org.apache.hc.client5.http.io.HttpClientConnectionManager.lease. Returns a `LeaseRequest` object which can be used to obtain a `ConnectionEndpoint` to cancel the request by calling `LeaseRequest#cancel()`. 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 calling `connect(ConnectionEndpoint, TimeValue, HttpContext)` in order to connect directly to the target or to the first proxy hop, and optionally calling `upgrade(ConnectionEndpoint, HttpContext)` method to upgrade the underlying transport to Transport Layer Security after having executed a `CONNECT` method to all intermediate proxy hops. Parameters id:String unique operation ID or `null`. route:HttpRoute HTTP route of the requested connection. requestTimeout:Timeout lease request timeout. state:Object expected state of the connection or `null` if the connection is not expected to carry any state. Annotations @Override

public LeaseRequest lease(final String id, final HttpRoute route, final Timeout requestTimeout, final Object state)

Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.lease.

Doc from org.apache.hc.client5.http.io.HttpClientConnectionManager.lease.

Returns a LeaseRequest object which can be used to obtain a ConnectionEndpoint to cancel the request by calling LeaseRequest#cancel().

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 calling connect(ConnectionEndpoint, TimeValue, HttpContext) in order to connect directly to the target or to the first proxy hop, and optionally calling upgrade(ConnectionEndpoint, HttpContext) method to upgrade the underlying transport to Transport Layer Security after having executed a CONNECT method to all intermediate proxy hops.

Parameters

id:String: unique operation ID or null.
route:HttpRoute: HTTP route of the requested connection.
requestTimeout:Timeout: lease request timeout.
state:Object: expected state of the connection or null if the connection is not expected to carry any state.

Annotations

@Override

release back to summary

release	back to summary
public synchronized void release(final ConnectionEndpoint endpoint, final Object state, final TimeValue keepAlive) Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.release. Doc from org.apache.hc.client5.http.io.HttpClientConnectionManager.release. 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 using `validDuration` and `timeUnit` parameters. Parameters endpoint:ConnectionEndpoint the managed endpoint. state:Object the new connection state of `null` if state-less. keepAlive:TimeValue the duration of time this connection is valid for reuse. Annotations @Override

public synchronized void release(final ConnectionEndpoint endpoint, final Object state, final TimeValue keepAlive)

Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.release.

Doc from org.apache.hc.client5.http.io.HttpClientConnectionManager.release.

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 using validDuration and timeUnit parameters.

Parameters

endpoint:ConnectionEndpoint: the managed endpoint.
state:Object: the new connection state of null if state-less.
keepAlive:TimeValue: the duration of time this connection is valid for reuse.

Annotations

@Override

setConnectionConfig	back to summary
public synchronized void setConnectionConfig(final ConnectionConfig connectionConfig) Since 5.2

setSocketConfig	back to summary
public synchronized void setSocketConfig(final SocketConfig socketConfig)

setTlsConfig	back to summary
public synchronized void setTlsConfig(final TlsConfig tlsConfig) Since 5.2

setValidateAfterInactivity back to summary

setValidateAfterInactivity	back to summary
public void setValidateAfterInactivity(final TimeValue validateAfterInactivity) Deprecated Use `setConnectionConfig(ConnectionConfig)` Defines period of inactivity after which persistent connections must be re-validated prior to being `lease(String, HttpRoute, Object)` 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. Annotations @Deprecated Since 5.1

public void setValidateAfterInactivity(final TimeValue validateAfterInactivity)

Deprecated

Use setConnectionConfig(ConnectionConfig)

Defines period of inactivity after which persistent connections must be re-validated prior to being lease(String, HttpRoute, Object) 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.

Annotations

@Deprecated

Since

5.1

upgrade	back to summary
public synchronized void upgrade(final ConnectionEndpoint endpoint, final HttpContext context) throws IOException Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.upgrade. Doc from org.apache.hc.client5.http.io.HttpClientConnectionManager.upgrade. Upgrades transport security of the given endpoint by using the TLS security protocol. Parameters endpoint:ConnectionEndpoint the managed endpoint. context:HttpContext the actual HTTP context. Annotations @Override

upgrade

back to summary

public synchronized void upgrade(final ConnectionEndpoint endpoint, final HttpContext context) throws IOException

Implements org.apache.hc.client5.http.io.HttpClientConnectionManager.upgrade.

Doc from org.apache.hc.client5.http.io.HttpClientConnectionManager.upgrade.

Upgrades transport security of the given endpoint by using the TLS security protocol.

Parameters

endpoint:ConnectionEndpoint: the managed endpoint.
context:HttpContext: the actual HTTP context.

Annotations

@Override

validate	back to summary
private void validate()

org.apache.hc.client5.http.impl.io back to summary

pack-priv Class BasicHttpClientConnectionManager.InternalConnectionEndpoint

Class Inheritance

extends ConnectionEndpoint

java.lang.Object
org.apache.hc.client5.http.io.ConnectionEndpoint
org.apache.hc.client5.http.impl.io.BasicHttpClientConnectionManager.InternalConnectionEndpoint

Field Summary

Modifier and Type	Field and Description
private final AtomicReference<ManagedHttpClientConnection>	connRef
private final HttpRoute	route

Constructor Summary

Access	Constructor and Description
public	InternalConnectionEndpoint(final HttpRoute route, final ManagedHttpClientConnection conn)

Method Summary

Modifier and Type	Method and Description
public void	close(final CloseMode How to close the receiver. closeMode) Implements org.apache.hc.core5.io.ModalCloseable.close. Closes this process or endpoint and releases any system resources associated with it.
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
pack-priv ManagedHttpClientConnection	detach()
public ClassicHttpResponse	execute(final String unique operation ID or `null`. exchangeId, final ClassicHttpRequest the request message. request, final HttpRequestExecutor the request executor. requestExecutor, final HttpContext the execution context. context) Implements abstract org.apache.hc.client5.http.io.ConnectionEndpoint.execute. Executes HTTP request using the provided request executor.
pack-priv ManagedHttpClientConnection	getConnection()
pack-priv HttpRoute	getRoute()
pack-priv ManagedHttpClientConnection	getValidatedConnection()
public boolean	isConnected() Implements abstract org.apache.hc.client5.http.io.ConnectionEndpoint.isConnected. Determines if the connection to the remote endpoint is still open and valid.
public void	setSocketTimeout(final Timeout timeout value timeout) Implements abstract org.apache.hc.client5.http.io.ConnectionEndpoint.setSocketTimeout. Sets the socket timeout value.

Field Detail

connRef	back to summary
private final AtomicReference<ManagedHttpClientConnection> connRef

route	back to summary
private final HttpRoute route

Constructor Detail

InternalConnectionEndpoint	back to summary
public InternalConnectionEndpoint(final HttpRoute route, final ManagedHttpClientConnection conn)

Method Detail

back to summary

public void close(final CloseMode closeMode)

Implements org.apache.hc.core5.io.ModalCloseable.close.

Doc from org.apache.hc.core5.io.ModalCloseable.close.

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

Parameters