org.apache.iceberg.aws.HttpClientProperties Maven / Gradle / Ivy
Show all versions of iceberg-aws Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.iceberg.aws;
import java.io.Serializable;
import java.util.Collections;
import java.util.Map;
import org.apache.iceberg.common.DynMethods;
import org.apache.iceberg.relocated.com.google.common.base.Strings;
import org.apache.iceberg.util.PropertyUtil;
import software.amazon.awssdk.awscore.client.builder.AwsSyncClientBuilder;
public class HttpClientProperties implements Serializable {
/**
* The type of {@link software.amazon.awssdk.http.SdkHttpClient} implementation used by {@link
* AwsClientFactory} If set, all AWS clients will use this specified HTTP client. If not set,
* {@link #CLIENT_TYPE_DEFAULT} will be used. For specific types supported, see CLIENT_TYPE_*
* defined below.
*/
public static final String CLIENT_TYPE = "http-client.type";
/**
* If this is set under {@link #CLIENT_TYPE}, {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient} will be used as the HTTP Client in {@link
* AwsClientFactory}
*/
public static final String CLIENT_TYPE_APACHE = "apache";
private static final String CLIENT_PREFIX = "http-client.";
/**
* If this is set under {@link #CLIENT_TYPE}, {@link
* software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient} will be used as the HTTP
* Client in {@link AwsClientFactory}
*/
public static final String CLIENT_TYPE_URLCONNECTION = "urlconnection";
public static final String CLIENT_TYPE_DEFAULT = CLIENT_TYPE_APACHE;
/**
* Used to configure the connection timeout in milliseconds for {@link
* software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient.Builder}. This flag only
* works when {@link #CLIENT_TYPE} is set to {@link #CLIENT_TYPE_URLCONNECTION}
*
* For more details, see
* https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/urlconnection/UrlConnectionHttpClient.Builder.html
*/
public static final String URLCONNECTION_CONNECTION_TIMEOUT_MS =
"http-client.urlconnection.connection-timeout-ms";
/**
* Used to configure the socket timeout in milliseconds for {@link
* software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient.Builder}. This flag only
* works when {@link #CLIENT_TYPE} is set to {@link #CLIENT_TYPE_URLCONNECTION}
*
*
For more details, see
* https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/urlconnection/UrlConnectionHttpClient.Builder.html
*/
public static final String URLCONNECTION_SOCKET_TIMEOUT_MS =
"http-client.urlconnection.socket-timeout-ms";
/**
* Used to configure the connection timeout in milliseconds for {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient.Builder}. This flag only works when {@link
* #CLIENT_TYPE} is set to {@link #CLIENT_TYPE_APACHE}
*
*
For more details, see
* https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
*/
public static final String APACHE_CONNECTION_TIMEOUT_MS =
"http-client.apache.connection-timeout-ms";
/**
* Used to configure the socket timeout in milliseconds for {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient.Builder}. This flag only works when {@link
* #CLIENT_TYPE} is set to {@link #CLIENT_TYPE_APACHE}
*
*
For more details, see
* https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
*/
public static final String APACHE_SOCKET_TIMEOUT_MS = "http-client.apache.socket-timeout-ms";
/**
* Used to configure the connection acquisition timeout in milliseconds for {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient.Builder}. This flag only works when {@link
* #CLIENT_TYPE} is set to {@link #CLIENT_TYPE_APACHE}
*
*
For more details, see
* https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
*/
public static final String APACHE_CONNECTION_ACQUISITION_TIMEOUT_MS =
"http-client.apache.connection-acquisition-timeout-ms";
/**
* Used to configure the connection max idle time in milliseconds for {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient.Builder}. This flag only works when {@link
* #CLIENT_TYPE} is set to {@link #CLIENT_TYPE_APACHE}
*
*
For more details, see
* https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
*/
public static final String APACHE_CONNECTION_MAX_IDLE_TIME_MS =
"http-client.apache.connection-max-idle-time-ms";
/**
* Used to configure the connection time to live in milliseconds for {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient.Builder}. This flag only works when {@link
* #CLIENT_TYPE} is set to {@link #CLIENT_TYPE_APACHE}
*
*
For more details, see
* https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
*/
public static final String APACHE_CONNECTION_TIME_TO_LIVE_MS =
"http-client.apache.connection-time-to-live-ms";
/**
* Used to configure whether to enable the expect continue setting for {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient.Builder}. This flag only works when {@link
* #CLIENT_TYPE} is set to {@link #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
*/
public static final String APACHE_EXPECT_CONTINUE_ENABLED =
"http-client.apache.expect-continue-enabled";
/**
* Used to configure the max connections number for {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient.Builder}. This flag only works when {@link
* #CLIENT_TYPE} is set to {@link #CLIENT_TYPE_APACHE}
*
*
For more details, see
* https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.Builder.html
*/
public static final String APACHE_MAX_CONNECTIONS = "http-client.apache.max-connections";
/**
* Used to configure whether to enable the tcp keep alive setting for {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient.Builder}. This flag only works when {@link
* #CLIENT_TYPE} is set to {@link #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
*/
public static final String APACHE_TCP_KEEP_ALIVE_ENABLED =
"http-client.apache.tcp-keep-alive-enabled";
/**
* Used to configure whether to use idle connection reaper for {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient.Builder}. This flag only works when {@link
* #CLIENT_TYPE} is set to {@link #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
*/
public static final String APACHE_USE_IDLE_CONNECTION_REAPER_ENABLED =
"http-client.apache.use-idle-connection-reaper-enabled";
private String httpClientType;
private final Map httpClientProperties;
public HttpClientProperties() {
this.httpClientType = CLIENT_TYPE_DEFAULT;
this.httpClientProperties = Collections.emptyMap();
}
public HttpClientProperties(Map properties) {
this.httpClientType =
PropertyUtil.propertyAsString(properties, CLIENT_TYPE, CLIENT_TYPE_DEFAULT);
this.httpClientProperties =
PropertyUtil.filterProperties(properties, key -> key.startsWith(CLIENT_PREFIX));
}
/**
* 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)
*
*/
public void applyHttpClientConfigurations(T builder) {
if (Strings.isNullOrEmpty(httpClientType)) {
httpClientType = CLIENT_TYPE_DEFAULT;
}
switch (httpClientType) {
case CLIENT_TYPE_URLCONNECTION:
UrlConnectionHttpClientConfigurations urlConnectionHttpClientConfigurations =
loadHttpClientConfigurations(UrlConnectionHttpClientConfigurations.class.getName());
urlConnectionHttpClientConfigurations.configureHttpClientBuilder(builder);
break;
case CLIENT_TYPE_APACHE:
ApacheHttpClientConfigurations apacheHttpClientConfigurations =
loadHttpClientConfigurations(ApacheHttpClientConfigurations.class.getName());
apacheHttpClientConfigurations.configureHttpClientBuilder(builder);
break;
default:
throw new IllegalArgumentException("Unrecognized HTTP client type " + httpClientType);
}
}
/**
* Dynamically load the http client builder to avoid runtime deps requirements of both {@link
* software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient} and {@link
* software.amazon.awssdk.http.apache.ApacheHttpClient}, since including both will cause error
* described in issue#6715
*/
private T loadHttpClientConfigurations(String impl) {
Object httpClientConfigurations;
try {
httpClientConfigurations =
DynMethods.builder("create")
.hiddenImpl(impl, Map.class)
.buildStaticChecked()
.invoke(httpClientProperties);
return (T) httpClientConfigurations;
} catch (NoSuchMethodException e) {
throw new IllegalArgumentException(
String.format("Cannot create %s to generate and configure the http client builder", impl),
e);
}
}
}