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

Modifier and Type	Field and Description
private final Timeout	connectTimeout
public static final ConnectionConfig	DEFAULT
private static final Timeout	DEFAULT_CONNECT_TIMEOUT
private final Timeout	socketTimeout
private final TimeValue	timeToLive
private final TimeValue	validateAfterInactivity

Access	Constructor and Description
protected	ConnectionConfig() Intended for CDI compatibility
pack-priv	ConnectionConfig(final Timeout connectTimeout, final Timeout socketTimeout, final TimeValue validateAfterInactivity, final TimeValue timeToLive)

Modifier and Type	Method and Description
protected ConnectionConfig	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public static ConnectionConfig.Builder	copy(final ConnectionConfig config)
public static ConnectionConfig.Builder	custom()
public Timeout	getConnectTimeout()
public Timeout	getSocketTimeout()
public TimeValue	getTimeToLive()
public TimeValue	getValidateAfterInactivity()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

connectTimeout	back to summary
private final Timeout connectTimeout

DEFAULT	back to summary
public static final ConnectionConfig DEFAULT

DEFAULT_CONNECT_TIMEOUT	back to summary
private static final Timeout DEFAULT_CONNECT_TIMEOUT

socketTimeout	back to summary
private final Timeout socketTimeout

timeToLive	back to summary
private final TimeValue timeToLive

validateAfterInactivity	back to summary
private final TimeValue validateAfterInactivity

ConnectionConfig	back to summary
protected ConnectionConfig() Intended for CDI compatibility

ConnectionConfig	back to summary
pack-priv ConnectionConfig(final Timeout connectTimeout, final Timeout socketTimeout, final TimeValue validateAfterInactivity, final TimeValue timeToLive)

Method Detail

clone back to summary

clone	back to summary
protected ConnectionConfig clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:ConnectionConfig a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

protected ConnectionConfig clone() throws CloneNotSupportedException

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:ConnectionConfig

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:: if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

copy	back to summary
public static ConnectionConfig.Builder copy(final ConnectionConfig config)

custom	back to summary
public static ConnectionConfig.Builder custom()

getConnectTimeout	back to summary
public Timeout getConnectTimeout() See Also `Builder#setConnectTimeout(Timeout)`

getSocketTimeout	back to summary
public Timeout getSocketTimeout() See Also `Builder#setSocketTimeout(Timeout)`

getTimeToLive	back to summary
public TimeValue getTimeToLive() See Also `(TimeValue)`

getValidateAfterInactivity	back to summary
public TimeValue getValidateAfterInactivity() See Also `Builder#setValidateAfterInactivity(TimeValue)`

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.apache.hc.client5.http.config back to summary

public Class ConnectionConfig.Builder

Class Inheritance

extends Object

java.lang.Object
org.apache.hc.client5.http.config.ConnectionConfig.Builder

Field Summary

Modifier and Type	Field and Description
private Timeout	connectTimeout
private Timeout	socketTimeout
private TimeValue	timeToLive
private TimeValue	validateAfterInactivity

Constructor Summary

Access	Constructor and Description
pack-priv	Builder()

Method Summary

Modifier and Type	Method and Description
public ConnectionConfig	build()
public ConnectionConfig.Builder	setConnectTimeout(final Timeout connectTimeout) Determines the timeout until a new connection is fully established.
public ConnectionConfig.Builder	setConnectTimeout(final long connectTimeout, final TimeUnit timeUnit)
public ConnectionConfig.Builder	setSocketTimeout(final int soTimeout, final TimeUnit timeUnit)
public ConnectionConfig.Builder	Returns: the default socket timeout value for I/O operations. setSocketTimeout(final Timeout soTimeout) Determines the default socket timeout value for I/O operations.
public ConnectionConfig.Builder	setTimeToLive(final TimeValue timeToLive) Defines the total span of time connections can be kept alive or execute requests.
public ConnectionConfig.Builder	setTimeToLive(final long timeToLive, final TimeUnit timeUnit)
public ConnectionConfig.Builder	setValidateAfterInactivity(final TimeValue validateAfterInactivity) Defines period of inactivity after which persistent connections must be re-validated prior to being leased to the consumer.
public ConnectionConfig.Builder	setValidateAfterInactivity(final long validateAfterInactivity, final TimeUnit timeUnit)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

connectTimeout	back to summary
private Timeout connectTimeout

socketTimeout	back to summary
private Timeout socketTimeout

timeToLive	back to summary
private TimeValue timeToLive

validateAfterInactivity	back to summary
private TimeValue validateAfterInactivity

Constructor Detail

Builder	back to summary
pack-priv Builder()

Method Detail

build	back to summary
public ConnectionConfig build()

setConnectTimeout	back to summary
public ConnectionConfig.Builder setConnectTimeout(final Timeout connectTimeout) Determines the timeout until a new connection is fully established. A timeout value of zero is interpreted as an infinite timeout. Default: 3 minutes

setConnectTimeout

back to summary

public ConnectionConfig.Builder setConnectTimeout(final Timeout connectTimeout)

Determines the timeout until a new connection is fully established.

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

Default: 3 minutes

setConnectTimeout	back to summary
public ConnectionConfig.Builder setConnectTimeout(final long connectTimeout, final TimeUnit timeUnit) See Also `setConnectTimeout(Timeout)`

setSocketTimeout	back to summary
public ConnectionConfig.Builder setSocketTimeout(final int soTimeout, final TimeUnit timeUnit) See Also `setSocketTimeout(Timeout)`

setSocketTimeout back to summary

setSocketTimeout	back to summary
public ConnectionConfig.Builder setSocketTimeout(final Timeout soTimeout) Determines the default socket timeout value for I/O operations. Default: `null` (undefined) Returns:ConnectionConfig.Builder the default socket timeout value for I/O operations.

public ConnectionConfig.Builder setSocketTimeout(final Timeout soTimeout)

Determines the default socket timeout value for I/O operations.

Default: null (undefined)

Returns:ConnectionConfig.Builder: the default socket timeout value for I/O operations.

setTimeToLive back to summary

setTimeToLive	back to summary
public ConnectionConfig.Builder setTimeToLive(final TimeValue timeToLive) Defines the total span of time connections can be kept alive or execute requests. Default: `null` (undefined)

public ConnectionConfig.Builder setTimeToLive(final TimeValue timeToLive)

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

Default: null (undefined)

setTimeToLive	back to summary
public ConnectionConfig.Builder setTimeToLive(final long timeToLive, final TimeUnit timeUnit) See Also `setTimeToLive(TimeValue)`

setValidateAfterInactivity back to summary

setValidateAfterInactivity	back to summary
public ConnectionConfig.Builder setValidateAfterInactivity(final TimeValue validateAfterInactivity) Defines period of inactivity after which persistent connections must be re-validated prior to being leased to the consumer. Negative values passed to this method disable connection validation. Default: `null` (undefined)

public ConnectionConfig.Builder setValidateAfterInactivity(final TimeValue validateAfterInactivity)

Defines period of inactivity after which persistent connections must be re-validated prior to being leased to the consumer. Negative values passed to this method disable connection validation.

Default: null (undefined)

setValidateAfterInactivity	back to summary
public ConnectionConfig.Builder setValidateAfterInactivity(final long validateAfterInactivity, final TimeUnit timeUnit) See Also `setValidateAfterInactivity(TimeValue)`

public Class ConnectionConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ConnectionConfig.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail