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

Class BasicHttpClientConnectionManager

java.lang.Object

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

All Implemented Interfaces:

HttpClientConnectionManager

public class BasicHttpClientConnectionManager
extends java.lang.Object
implements HttpClientConnectionManager

A connection manager for a single connection. This connection manager maintains only one active connection. Even though this class is fully thread-safe it ought to be used by one execution thread only, as only one thread a time can lease the connection at a time.

This connection manager will make an effort to reuse the connection for subsequent requests with the same route. It will, however, close the existing connection and open it for the given route, if the route of the persistent connection does not match that of the connection request. If the connection has been already been allocated IllegalStateException is thrown.

This connection manager implementation should be used inside an EJB container instead of PoolingHttpClientConnectionManager.

Since:

4.3

Constructor Summary

Constructors

Constructor and Description
BasicHttpClientConnectionManager()
BasicHttpClientConnectionManager(<any> socketFactoryRegistry)
BasicHttpClientConnectionManager(<any> socketFactoryRegistry, <any> connFactory)
BasicHttpClientConnectionManager(<any> socketFactoryRegistry, <any> connFactory, SchemePortResolver schemePortResolver, DnsResolver dnsResolver)
BasicHttpClientConnectionManager(HttpClientConnectionOperator httpClientConnectionOperator, <any> connFactory)

Method Summary

Modifier and Type	Method and Description
void	close()
void	close(CloseMode closeMode)
void	closeExpired()
void	closeIdle(TimeValue idleTime)
void	connect(ConnectionEndpoint endpoint, TimeValue connectTimeout, HttpContext context) 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).
SocketConfig	getSocketConfig()
TimeValue	getValidateAfterInactivity()
LeaseRequest	lease(java.lang.String id, HttpRoute route, java.lang.Object state)
LeaseRequest	lease(java.lang.String id, HttpRoute route, Timeout requestTimeout, java.lang.Object state) Returns a LeaseRequest object which can be used to obtain a ConnectionEndpoint to cancel the request by calling LeaseRequest#cancel().
void	release(ConnectionEndpoint endpoint, java.lang.Object state, TimeValue keepAlive) Releases the endpoint back to the manager making it potentially re-usable by other consumers.
void	setSocketConfig(SocketConfig socketConfig)
void	setValidateAfterInactivity(TimeValue validateAfterInactivity) Defines period of inactivity after which persistent connections must be re-validated prior to being lease(String, HttpRoute, Object) leased} to the consumer.
void	upgrade(ConnectionEndpoint endpoint, HttpContext context) Upgrades transport security of the given endpoint by using the TLS security protocol.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicHttpClientConnectionManager

public BasicHttpClientConnectionManager(<any> socketFactoryRegistry,
                                        <any> connFactory,
                                        SchemePortResolver schemePortResolver,
                                        DnsResolver dnsResolver)

BasicHttpClientConnectionManager

public BasicHttpClientConnectionManager(HttpClientConnectionOperator httpClientConnectionOperator,
                                        <any> connFactory)

Since:

4.4

BasicHttpClientConnectionManager

public BasicHttpClientConnectionManager(<any> socketFactoryRegistry,
                                        <any> connFactory)

BasicHttpClientConnectionManager

public BasicHttpClientConnectionManager(<any> socketFactoryRegistry)

BasicHttpClientConnectionManager

public BasicHttpClientConnectionManager()

Method Detail

close

public void close()

close

public void close(CloseMode closeMode)

getSocketConfig

public SocketConfig getSocketConfig()

setSocketConfig

public void setSocketConfig(SocketConfig socketConfig)

lease

public LeaseRequest lease(java.lang.String id,
                          HttpRoute route,
                          java.lang.Object state)

lease

public LeaseRequest lease(java.lang.String id,
                          HttpRoute route,
                          Timeout requestTimeout,
                          java.lang.Object state)

Description copied from interface: HttpClientConnectionManager

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

Specified by:

lease in interface HttpClientConnectionManager

Parameters:

id - unique operation ID or null.

route - HTTP route of the requested connection.

requestTimeout - lease request timeout.

state - expected state of the connection or null if the connection is not expected to carry any state.

release

public void release(ConnectionEndpoint endpoint,
                    java.lang.Object state,
                    TimeValue keepAlive)

Description copied from interface: HttpClientConnectionManager

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.

Specified by:

release in interface HttpClientConnectionManager

Parameters:

endpoint - the managed endpoint.

state - the new connection state of null if state-less.

keepAlive - the duration of time this connection is valid for reuse.

connect

public void connect(ConnectionEndpoint endpoint,
                    TimeValue connectTimeout,
                    HttpContext context)
             throws java.io.IOException

Description copied from interface: HttpClientConnectionManager

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 interface HttpClientConnectionManager

Parameters:

endpoint - the managed endpoint.

connectTimeout - connect timeout.

context - the actual HTTP context.

Throws:

java.io.IOException

upgrade

public void upgrade(ConnectionEndpoint endpoint,
                    HttpContext context)
             throws java.io.IOException

Description copied from interface: HttpClientConnectionManager

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

Specified by:

upgrade in interface HttpClientConnectionManager

Parameters:

endpoint - the managed endpoint.

context - the actual HTTP context.

Throws:

java.io.IOException

closeExpired

public void closeExpired()

closeIdle

public void closeIdle(TimeValue idleTime)

getValidateAfterInactivity

public TimeValue getValidateAfterInactivity()

Since:

5.1

See Also:

setValidateAfterInactivity(TimeValue)

setValidateAfterInactivity

public void setValidateAfterInactivity(TimeValue validateAfterInactivity)

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.

Since:

5.1