Address review comments

Signed-off-by: Souvik Bose <[email protected]>
opensearch-project · Oct 22, 2024 · 275f429 · 275f429
1 parent 60c8f63
commit 275f429
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 23 deletions.
diff --git a/...ws-plugin-api/src/main/java/org/opensearch/dataprepper/aws/api/AwsCredentialsOptions.java b/...ws-plugin-api/src/main/java/org/opensearch/dataprepper/aws/api/AwsCredentialsOptions.java
@@ -16,28 +16,28 @@
  */
 public class AwsCredentialsOptions {
     private static final AwsCredentialsOptions DEFAULT_OPTIONS = new AwsCredentialsOptions();
-    private static final AwsCredentialsOptions DEFAULT_OPTIONS_WITH_DEFAULT_CREDS =
-            AwsCredentialsOptions.builder().withUseDefaultCredentials(true).build();
+    private static final AwsCredentialsOptions DEFAULT_OPTIONS_WITH_DEFAULT_CREDS_PROVIDER =
+            AwsCredentialsOptions.builder().withUseDefaultCredentialsProvider(true).build();
     private final String stsRoleArn;
     private final String stsExternalId;
     private final Region region;
     private final Map<String, String> stsHeaderOverrides;
-    private final boolean useDefaultCredentials;
+    private final boolean useDefaultCredentialsProvider;
 
     private AwsCredentialsOptions(final Builder builder) {
         this.stsRoleArn = builder.stsRoleArn;
         this.stsExternalId = builder.stsExternalId;
         this.region = builder.region;
         this.stsHeaderOverrides = builder.stsHeaderOverrides != null ? new HashMap<>(builder.stsHeaderOverrides) : Collections.emptyMap();
-        this.useDefaultCredentials = builder.useDefaultCredentials;
+        this.useDefaultCredentialsProvider = builder.useDefaultCredentialsProvider;
     }
 
     private AwsCredentialsOptions() {
         this.stsRoleArn = null;
         this.stsExternalId = null;
         this.region = null;
         this.stsHeaderOverrides = Collections.emptyMap();
-        this.useDefaultCredentials = false;
+        this.useDefaultCredentialsProvider = false;
     }
 
     /**
@@ -54,8 +54,8 @@ public static AwsCredentialsOptions defaultOptions() {
         return DEFAULT_OPTIONS;
     }
 
-    public static AwsCredentialsOptions defaultOptionsWithDefaultCreds() {
-        return DEFAULT_OPTIONS_WITH_DEFAULT_CREDS;
+    public static AwsCredentialsOptions defaultOptionsWithDefaultCredentialsProvider() {
+        return DEFAULT_OPTIONS_WITH_DEFAULT_CREDS_PROVIDER;
     }
 
     public String getStsRoleArn() {
@@ -74,8 +74,8 @@ public Map<String, String> getStsHeaderOverrides() {
         return stsHeaderOverrides;
     }
 
-    public boolean isUseDefaultCredentials() {
-        return useDefaultCredentials;
+    public boolean isUseDefaultCredentialsProvider() {
+        return useDefaultCredentialsProvider;
     }
 
     /**
@@ -86,7 +86,7 @@ public static class Builder {
         private String stsExternalId;
         private Region region;
         private Map<String, String> stsHeaderOverrides = Collections.emptyMap();
-        private boolean useDefaultCredentials = false;
+        private boolean useDefaultCredentialsProvider = false;
 
         /**
          * Sets the STS role ARN to use.
@@ -139,11 +139,11 @@ public Builder withStsHeaderOverrides(final Map<String, String> stsHeaderOverrid
         /**
          * Configures whether to use default credentials.
          *
-         * @param useDefaultCredentials
+         * @param useDefaultCredentialsProvider
          * @return The {@link Builder} for continuing to build
          */
-        public Builder withUseDefaultCredentials(final boolean useDefaultCredentials) {
-            this.useDefaultCredentials = useDefaultCredentials;
+        public Builder withUseDefaultCredentialsProvider(final boolean useDefaultCredentialsProvider) {
+            this.useDefaultCredentialsProvider = useDefaultCredentialsProvider;
             return this;
         }
 

diff --git a/...lugin-api/src/test/java/org/opensearch/dataprepper/aws/api/AwsCredentialsOptionsTest.java b/...lugin-api/src/test/java/org/opensearch/dataprepper/aws/api/AwsCredentialsOptionsTest.java
@@ -155,16 +155,17 @@ void defaultOptions_returns_same_instance_on_multiple_calls() {
 
     @Test
     void with_DefaultRole() {
-        final AwsCredentialsOptions awsCredentialsOptions = AwsCredentialsOptions.defaultOptionsWithDefaultCreds();
+        final AwsCredentialsOptions awsCredentialsOptionsWithDefaultCredentialsProvider
+                = AwsCredentialsOptions.defaultOptionsWithDefaultCredentialsProvider();
 
-        assertThat(awsCredentialsOptions, notNullValue());
-        assertThat(awsCredentialsOptions.getStsRoleArn(), nullValue());
-        assertTrue(awsCredentialsOptions.isUseDefaultCredentials());
+        assertThat(awsCredentialsOptionsWithDefaultCredentialsProvider, notNullValue());
+        assertThat(awsCredentialsOptionsWithDefaultCredentialsProvider.getStsRoleArn(), nullValue());
+        assertTrue(awsCredentialsOptionsWithDefaultCredentialsProvider.isUseDefaultCredentialsProvider());
     }
 
     @Test
     void defaultCredentialsOptions_returns_same_instance_on_multiple_calls() {
-        assertThat(AwsCredentialsOptions.defaultOptionsWithDefaultCreds(),
-                sameInstance(AwsCredentialsOptions.defaultOptionsWithDefaultCreds()));
+        assertThat(AwsCredentialsOptions.defaultOptionsWithDefaultCredentialsProvider(),
+                sameInstance(AwsCredentialsOptions.defaultOptionsWithDefaultCredentialsProvider()));
     }
 }
diff --git a/...ugin/src/main/java/org/opensearch/dataprepper/plugins/aws/CredentialsProviderFactory.java b/...ugin/src/main/java/org/opensearch/dataprepper/plugins/aws/CredentialsProviderFactory.java
@@ -50,7 +50,7 @@ Region getDefaultRegion() {
     AwsCredentialsProvider providerFromOptions(final AwsCredentialsOptions credentialsOptions) {
         Objects.requireNonNull(credentialsOptions);
 
-        if (credentialsOptions.isUseDefaultCredentials()) {
+        if (credentialsOptions.isUseDefaultCredentialsProvider()) {
             return DefaultCredentialsProvider.create();
         }
 

diff --git a/...-plugins/aws-plugin/src/test/java/org/opensearch/dataprepper/plugins/aws/AwsPluginIT.java b/...-plugins/aws-plugin/src/test/java/org/opensearch/dataprepper/plugins/aws/AwsPluginIT.java
@@ -175,7 +175,7 @@ void test_AwsPlugin_without_STS_role_and_without_default_role_uses_default_role(
 
         final AwsCredentialsOptions awsCredentialsOptions1 = AwsCredentialsOptions.builder()
                 .withRegion(Region.US_EAST_1)
-                .withUseDefaultCredentials(true)
+                .withUseDefaultCredentialsProvider(true)
                 .build();
 
         final AwsCredentialsProvider awsCredentialsProvider1 = awsCredentialsSupplier.getProvider(awsCredentialsOptions1);
@@ -184,7 +184,7 @@ void test_AwsPlugin_without_STS_role_and_without_default_role_uses_default_role(
 
         final AwsCredentialsOptions awsCredentialsOptions2 = AwsCredentialsOptions.builder()
                 .withRegion(Region.US_EAST_1)
-                .withUseDefaultCredentials(true)
+                .withUseDefaultCredentialsProvider(true)
                 .build();
 
         final AwsCredentialsProvider awsCredentialsProvider2 = awsCredentialsSupplier.getProvider(awsCredentialsOptions2);

diff --git a/...src/main/java/org/opensearch/dataprepper/plugins/kinesis/source/KinesisClientFactory.java b/...src/main/java/org/opensearch/dataprepper/plugins/kinesis/source/KinesisClientFactory.java
@@ -34,7 +34,7 @@ public KinesisClientFactory(final AwsCredentialsSupplier awsCredentialsSupplier,
                 .withStsHeaderOverrides(awsAuthenticationConfig.getAwsStsHeaderOverrides())
                 .build());
         defaultCredentialsProvider = awsCredentialsSupplier.getProvider(
-                AwsCredentialsOptions.defaultOptionsWithDefaultCreds());
+                AwsCredentialsOptions.defaultOptionsWithDefaultCredentialsProvider());
         this.awsAuthenticationConfig = awsAuthenticationConfig;
     }