org.apache.hc.client5.http.config

Class ConnectionConfig

java.lang.Object

org.apache.hc.client5.http.config.ConnectionConfig

All Implemented Interfaces:

Cloneable

@Contract(threading=IMMUTABLE)
public class ConnectionConfig
extends Object
implements Cloneable

Immutable class encapsulating connection initialization and management settings.

Since:

5.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectionConfig.Builder Builder for ConnectionConfig.

Field Summary

Fields

Modifier and Type	Field and Description
static ConnectionConfig	DEFAULT The default connection configuration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConnectionConfig() Intended for CDI compatibility

Method Summary

Modifier and Type	Method and Description
protected ConnectionConfig	clone()
static ConnectionConfig.Builder	copy(ConnectionConfig config) Creates a new builder for ConnectionConfig based on an existing instance.
static ConnectionConfig.Builder	custom() Creates a new builder for ConnectionConfig.
Timeout	getConnectTimeout() Gets the timeout until the target endpoint acknowledges accepting the connection request.
Timeout	getIdleTimeout() Gets the maximum period of idleness for a connection.
Timeout	getSocketTimeout() Gets the default socket timeout value for I/O operations on connections created by this configuration.
TimeValue	getTimeToLive() Gets the total span of time connections can be kept alive or execute requests.
TimeValue	getValidateAfterInactivity() Gets the period of inactivity after which persistent connections must be re-validated.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final ConnectionConfig DEFAULT

The default connection configuration.

• Timeout connectTimeout: 3 minutes
• Timeout socketTimeout: null (undefined)
• Timeout idleTimeout: null (undefined)
• TimeValue validateAfterInactivity: null (undefined)
• TimeValue timeToLive: null (undefined)

Constructor Detail

ConnectionConfig

protected ConnectionConfig()

Intended for CDI compatibility

Method Detail

getSocketTimeout

public Timeout getSocketTimeout()

Gets the default socket timeout value for I/O operations on connections created by this configuration. A timeout value of zero is interpreted as an infinite timeout.

Returns:

the default socket timeout value, defaults to null.

See Also:

ConnectionConfig.Builder.setSocketTimeout(Timeout)

getConnectTimeout

public Timeout getConnectTimeout()

Gets the timeout until the target endpoint acknowledges accepting the connection request.

Note that isn't the same time as the new connection being fully established. An HTTPS connection cannot be considered fully established until the TLS handshake has been successfully completed.

A timeout value of zero is interpreted as an infinite timeout.

Returns:

the timeout until the target endpoint acknowledges accepting the connection request, defaults to 3 minutes.

See Also:

ConnectionConfig.Builder.setConnectTimeout(Timeout)

getIdleTimeout

public Timeout getIdleTimeout()

Gets the maximum period of idleness for a connection.

Implementations can use this value to discard connections that have been idle for too long.

Returns:

the maximum period of idleness for a connection, defaults to null.

See Also:

ConnectionConfig.Builder.setIdleTimeout(Timeout)

getValidateAfterInactivity

public TimeValue getValidateAfterInactivity()

Gets the period of inactivity after which persistent connections must be re-validated.

Returns:

the period of inactivity after which persistent connections must be re-validated, defaults to null.

See Also:

ConnectionConfig.Builder.setValidateAfterInactivity(TimeValue)

getTimeToLive

public TimeValue getTimeToLive()

Gets the total span of time connections can be kept alive or execute requests.

Returns:

the total span of time connections can be kept alive or execute requests, defaults to null.

See Also:

(TimeValue)

clone

protected ConnectionConfig clone()
                          throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

toString

public String toString()

Overrides:

toString in class Object

custom

public static ConnectionConfig.Builder custom()

Creates a new builder for ConnectionConfig.

Returns:

a new builder for ConnectionConfig.

copy

public static ConnectionConfig.Builder copy(ConnectionConfig config)

Creates a new builder for ConnectionConfig based on an existing instance.

Parameters:

config - the instance to copy.

Returns:

a new builder for ConnectionConfig.