org.apache.iceberg.aws

Class HttpClientProperties

java.lang.Object

org.apache.iceberg.aws.HttpClientProperties

All Implemented Interfaces:

java.io.Serializable

public class HttpClientProperties
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APACHE_CONNECTION_ACQUISITION_TIMEOUT_MS Used to configure the connection acquisition timeout in milliseconds for ApacheHttpClient.Builder.
static java.lang.String	APACHE_CONNECTION_MAX_IDLE_TIME_MS Used to configure the connection max idle time in milliseconds for ApacheHttpClient.Builder.
static java.lang.String	APACHE_CONNECTION_TIME_TO_LIVE_MS Used to configure the connection time to live in milliseconds for ApacheHttpClient.Builder.
static java.lang.String	APACHE_CONNECTION_TIMEOUT_MS Used to configure the connection timeout in milliseconds for ApacheHttpClient.Builder.
static java.lang.String	APACHE_EXPECT_CONTINUE_ENABLED Used to configure whether to enable the expect continue setting for ApacheHttpClient.Builder.
static java.lang.String	APACHE_MAX_CONNECTIONS Used to configure the max connections number for ApacheHttpClient.Builder.
static java.lang.String	APACHE_SOCKET_TIMEOUT_MS Used to configure the socket timeout in milliseconds for ApacheHttpClient.Builder.
static java.lang.String	APACHE_TCP_KEEP_ALIVE_ENABLED Used to configure whether to enable the tcp keep alive setting for ApacheHttpClient.Builder.
static java.lang.String	APACHE_USE_IDLE_CONNECTION_REAPER_ENABLED Used to configure whether to use idle connection reaper for ApacheHttpClient.Builder.
static java.lang.String	CLIENT_TYPE The type of SdkHttpClient implementation used by AwsClientFactory If set, all AWS clients will use this specified HTTP client.
static java.lang.String	CLIENT_TYPE_APACHE If this is set under CLIENT_TYPE, ApacheHttpClient will be used as the HTTP Client in AwsClientFactory
static java.lang.String	CLIENT_TYPE_DEFAULT
static java.lang.String	CLIENT_TYPE_URLCONNECTION If this is set under CLIENT_TYPE, UrlConnectionHttpClient will be used as the HTTP Client in AwsClientFactory
static java.lang.String	URLCONNECTION_CONNECTION_TIMEOUT_MS Used to configure the connection timeout in milliseconds for UrlConnectionHttpClient.Builder.
static java.lang.String	URLCONNECTION_SOCKET_TIMEOUT_MS Used to configure the socket timeout in milliseconds for UrlConnectionHttpClient.Builder.

Constructor Summary

Constructors

Constructor and Description
HttpClientProperties()
HttpClientProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Method Summary

Modifier and Type	Method and Description
<T extends software.amazon.awssdk.awscore.client.builder.AwsSyncClientBuilder> void	applyHttpClientConfigurations(T builder) Configure the httpClient for a client according to the HttpClientType.

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_TYPE

public static final java.lang.String CLIENT_TYPE

The type of SdkHttpClient implementation used by AwsClientFactory If set, all AWS clients will use this specified HTTP client. If not set, CLIENT_TYPE_DEFAULT will be used. For specific types supported, see CLIENT_TYPE_* defined below.

See Also:

Constant Field Values

CLIENT_TYPE_APACHE

public static final java.lang.String CLIENT_TYPE_APACHE

If this is set under CLIENT_TYPE, ApacheHttpClient will be used as the HTTP Client in AwsClientFactory

See Also:

Constant Field Values

CLIENT_TYPE_URLCONNECTION

public static final java.lang.String CLIENT_TYPE_URLCONNECTION

If this is set under CLIENT_TYPE, UrlConnectionHttpClient will be used as the HTTP Client in AwsClientFactory

See Also:

Constant Field Values

CLIENT_TYPE_DEFAULT

public static final java.lang.String CLIENT_TYPE_DEFAULT

See Also:

Constant Field Values

URLCONNECTION_CONNECTION_TIMEOUT_MS

public static final java.lang.String URLCONNECTION_CONNECTION_TIMEOUT_MS

Used to configure the connection timeout in milliseconds for UrlConnectionHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_URLCONNECTION

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/urlconnection/UrlConnectionHttpClient.Builder.html

See Also:

Constant Field Values

URLCONNECTION_SOCKET_TIMEOUT_MS

public static final java.lang.String URLCONNECTION_SOCKET_TIMEOUT_MS

Used to configure the socket timeout in milliseconds for UrlConnectionHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_URLCONNECTION

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/urlconnection/UrlConnectionHttpClient.Builder.html

See Also:

Constant Field Values

APACHE_CONNECTION_TIMEOUT_MS

public static final java.lang.String APACHE_CONNECTION_TIMEOUT_MS

Used to configure the connection timeout in milliseconds for ApacheHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_APACHE

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html

See Also:

Constant Field Values

APACHE_SOCKET_TIMEOUT_MS

public static final java.lang.String APACHE_SOCKET_TIMEOUT_MS

Used to configure the socket timeout in milliseconds for ApacheHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_APACHE

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html

See Also:

Constant Field Values

APACHE_CONNECTION_ACQUISITION_TIMEOUT_MS

public static final java.lang.String APACHE_CONNECTION_ACQUISITION_TIMEOUT_MS

Used to configure the connection acquisition timeout in milliseconds for ApacheHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_APACHE

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html

See Also:

Constant Field Values

APACHE_CONNECTION_MAX_IDLE_TIME_MS

public static final java.lang.String APACHE_CONNECTION_MAX_IDLE_TIME_MS

Used to configure the connection max idle time in milliseconds for ApacheHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_APACHE

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html

See Also:

Constant Field Values

APACHE_CONNECTION_TIME_TO_LIVE_MS

public static final java.lang.String APACHE_CONNECTION_TIME_TO_LIVE_MS

Used to configure the connection time to live in milliseconds for ApacheHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_APACHE

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html

See Also:

Constant Field Values

APACHE_EXPECT_CONTINUE_ENABLED

public static final java.lang.String APACHE_EXPECT_CONTINUE_ENABLED

Used to configure whether to enable the expect continue setting for ApacheHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_APACHE

In default, this is disabled.

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html

See Also:

Constant Field Values

APACHE_MAX_CONNECTIONS

public static final java.lang.String APACHE_MAX_CONNECTIONS

Used to configure the max connections number for ApacheHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_APACHE

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html

See Also:

Constant Field Values

APACHE_TCP_KEEP_ALIVE_ENABLED

public static final java.lang.String APACHE_TCP_KEEP_ALIVE_ENABLED

Used to configure whether to enable the tcp keep alive setting for ApacheHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_APACHE.

In default, this is disabled.

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html

See Also:

Constant Field Values

APACHE_USE_IDLE_CONNECTION_REAPER_ENABLED

public static final java.lang.String APACHE_USE_IDLE_CONNECTION_REAPER_ENABLED

Used to configure whether to use idle connection reaper for ApacheHttpClient.Builder. This flag only works when CLIENT_TYPE is set to CLIENT_TYPE_APACHE.

In default, this is enabled.

For more details, see https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html

See Also:

Constant Field Values

Constructor Detail

HttpClientProperties

public HttpClientProperties()

HttpClientProperties

public HttpClientProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Method Detail

applyHttpClientConfigurations

public <T extends software.amazon.awssdk.awscore.client.builder.AwsSyncClientBuilder> void applyHttpClientConfigurations(T builder)

Configure the httpClient for a client according to the HttpClientType. The two supported HttpClientTypes are urlconnection and apache

Sample usage:

     S3Client.builder().applyMutation(awsProperties::applyHttpClientConfigurations)