AWS: create HttpClientProperties, move s3 related methods into S3FileIOProperties #7562
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| /* | ||
| * 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.util.Map; | ||
| import org.apache.iceberg.common.DynClasses; | ||
| import org.apache.iceberg.common.DynMethods; | ||
| import org.apache.iceberg.relocated.com.google.common.base.Preconditions; | ||
| import org.apache.iceberg.relocated.com.google.common.base.Strings; | ||
| import org.apache.iceberg.util.PropertyUtil; | ||
| import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; | ||
| import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; | ||
| import software.amazon.awssdk.auth.credentials.AwsSessionCredentials; | ||
| import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider; | ||
| import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider; | ||
|
|
||
| public class AwsClientProperties { | ||
| /** | ||
| * Configure the AWS credentials provider used to create AWS clients. A fully qualified concrete | ||
| * class with package that implements the {@link AwsCredentialsProvider} interface is required. | ||
| * | ||
| * <p>Additionally, the implementation class must also have a create() or create(Map) method | ||
| * implemented, which returns an instance of the class that provides aws credentials provider. | ||
| * | ||
| * <p>Example: | ||
| * client.credentials-provider=software.amazon.awssdk.auth.credentials.SystemPropertyCredentialsProvider | ||
| * | ||
| * <p>When set, the default client factory {@link | ||
| * org.apache.iceberg.aws.AwsClientFactories#defaultFactory()} and other AWS client factory | ||
| * classes will use this provider to get AWS credentials provided instead of reading the default | ||
| * credential chain to get AWS access credentials. | ||
| */ | ||
| public static final String CLIENT_CREDENTIALS_PROVIDER = "client.credentials-provider"; | ||
|
|
||
| /** | ||
| * Used by the client.credentials-provider configured value that will be used by {@link | ||
| * org.apache.iceberg.aws.AwsClientFactories#defaultFactory()} and other AWS client factory | ||
| * classes to pass provider-specific properties. Each property consists of a key name and an | ||
| * associated value. | ||
| */ | ||
| private static final String CLIENT_CREDENTIAL_PROVIDER_PREFIX = "client.credentials-provider."; | ||
|
|
||
| private String clientCredentialsProvider; | ||
| private final Map<String, String> clientCredentialsProviderProperties; | ||
|
|
||
| public AwsClientProperties() { | ||
| this.clientCredentialsProvider = null; | ||
| this.clientCredentialsProviderProperties = null; | ||
| } | ||
|
|
||
| public AwsClientProperties(Map<String, String> properties) { | ||
| this.clientCredentialsProvider = properties.get(CLIENT_CREDENTIALS_PROVIDER); | ||
| this.clientCredentialsProviderProperties = | ||
| PropertyUtil.propertiesWithPrefix(properties, CLIENT_CREDENTIAL_PROVIDER_PREFIX); | ||
| } | ||
|
|
||
| @SuppressWarnings("checkstyle:HiddenField") | ||
| public AwsCredentialsProvider credentialsProvider( | ||
|
jackye1995 marked this conversation as resolved.
|
||
| String accessKeyId, String secretAccessKey, String sessionToken) { | ||
| if (accessKeyId != null) { | ||
|
Contributor
There was a problem hiding this comment. and
Contributor
There was a problem hiding this comment. Maybe we should use
Contributor
Author
There was a problem hiding this comment.
Contributor
There was a problem hiding this comment. yeah, that's probably a miss we can fix here |
||
| if (sessionToken == null) { | ||
| return StaticCredentialsProvider.create( | ||
| AwsBasicCredentials.create(accessKeyId, secretAccessKey)); | ||
| } else { | ||
| return StaticCredentialsProvider.create( | ||
| AwsSessionCredentials.create(accessKeyId, secretAccessKey, sessionToken)); | ||
| } | ||
| } | ||
|
|
||
| if (!Strings.isNullOrEmpty(this.clientCredentialsProvider)) { | ||
| return credentialsProvider(this.clientCredentialsProvider); | ||
| } | ||
|
|
||
| return DefaultCredentialsProvider.create(); | ||
| } | ||
|
|
||
| private AwsCredentialsProvider credentialsProvider(String credentialsProviderClass) { | ||
| Class<?> providerClass; | ||
| try { | ||
| providerClass = DynClasses.builder().impl(credentialsProviderClass).buildChecked(); | ||
| } catch (ClassNotFoundException e) { | ||
| throw new IllegalArgumentException( | ||
| String.format( | ||
| "Cannot load class %s, it does not exist in the classpath", credentialsProviderClass), | ||
| e); | ||
| } | ||
|
|
||
| Preconditions.checkArgument( | ||
| AwsCredentialsProvider.class.isAssignableFrom(providerClass), | ||
| String.format( | ||
| "Cannot initialize %s, it does not implement %s.", | ||
| credentialsProviderClass, AwsCredentialsProvider.class.getName())); | ||
|
|
||
| AwsCredentialsProvider provider; | ||
| try { | ||
| try { | ||
| provider = | ||
| DynMethods.builder("create") | ||
| .hiddenImpl(providerClass, Map.class) | ||
| .buildStaticChecked() | ||
| .invoke(clientCredentialsProviderProperties); | ||
| } catch (NoSuchMethodException e) { | ||
| provider = | ||
| DynMethods.builder("create").hiddenImpl(providerClass).buildStaticChecked().invoke(); | ||
| } | ||
|
|
||
| return provider; | ||
| } catch (NoSuchMethodException e) { | ||
| throw new IllegalArgumentException( | ||
| String.format( | ||
| "Cannot create an instance of %s, it does not contain a static 'create' or 'create(Map<String, String>)' method", | ||
| credentialsProviderClass), | ||
| e); | ||
| } | ||
|
Comment on lines
+111
to
+165
Contributor
There was a problem hiding this comment. This block is a bit hard to read imo, I got what's going on but while we're at this refactoring we can take the opportunity to do some cleanup. For this could we have a separate helper for obtaining the provider with some inline comment on our "fallback" behavior. |
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.