Fix the bug of client endpoint override being ignored

Author: Quanzzzz

.changes/next-release/bugfix-AWSS3-3df5a2e.json

@@ -0,0 +1,6 @@
+{
+    "category": "AWS S3", 
+    "contributor": "", 
+    "type": "bugfix", 
+    "description": "Fix the bug that getUrl in S3Utilities ignores the overriding endpoint in the client."
+}

services/s3/src/main/java/software/amazon/awssdk/services/s3/S3Utilities.java

@@ -73,6 +73,7 @@
 @SdkPublicApi
 public final class S3Utilities {
     private final Region region;
+    private final URI endpoint;
     private final S3Configuration s3Configuration;
     private final ProfileFile profileFile;
     private final String profileName;
@@ -83,6 +84,7 @@ public final class S3Utilities {
      */
     private S3Utilities(Builder builder) {
         this.region = Validate.paramNotNull(builder.region, "Region");
+        this.endpoint = builder.endpoint;
         this.s3Configuration = builder.s3Configuration;
         this.profileFile = builder.profileFile;
         this.profileName = builder.profileName;
@@ -100,6 +102,7 @@ public static Builder builder() {
     static S3Utilities create(SdkClientConfiguration clientConfiguration) {
         return S3Utilities.builder()
                           .region(clientConfiguration.option(AwsClientOption.AWS_REGION))
+                          .endpoint(clientConfiguration.option(SdkClientOption.ENDPOINT))
                           .s3Configuration((S3Configuration) clientConfiguration.option(SdkClientOption.SERVICE_CONFIGURATION))
                           .profileFile(clientConfiguration.option(SdkClientOption.PROFILE_FILE))
                           .profileName(clientConfiguration.option(SdkClientOption.PROFILE_NAME))
@@ -188,8 +191,9 @@ private Region resolveRegionForGetUrl(GetUrlRequest getUrlRequest) {
     /**
      * If endpoint is not present, construct a default endpoint using the region information.
      */
-    private URI resolveEndpoint(URI endpoint, Region region) {
-        return endpoint != null ? endpoint
+    private URI resolveEndpoint(URI requestOverrideEndpoint, Region region) {
+        URI overrideEndpoint = requestOverrideEndpoint != null ? requestOverrideEndpoint : endpoint;
+        return overrideEndpoint != null ? overrideEndpoint
                                 : new DefaultServiceEndpointBuilder("s3", "https").withRegion(region)
                                                                                   .withProfileFile(profileFile)
                                                                                   .withProfileName(profileName)
@@ -227,6 +231,7 @@ private SdkHttpFullRequest createMarshalledRequest(GetUrlRequest getUrlRequest,
      */
     public static final class Builder {
         private Region region;
+        private URI endpoint;
 
         private S3Configuration s3Configuration;
         private ProfileFile profileFile;
@@ -248,6 +253,19 @@ public Builder region(Region region) {
             return this;
         }
 
+        /**
+         * The default endpoint to use when working with the methods in {@link S3Utilities} class.
+         *
+         * There can be methods in {@link S3Utilities} that don't need the endpoint info.
+         * In that case, this option will be ignored when using those methods.
+         *
+         * @return This object for method chaining
+         */
+        public Builder endpoint(URI endpoint) {
+            this.endpoint = endpoint;
+            return this;
+        }
+
         /**
          * Sets the S3 configuration to enable options like path style access, dual stack, accelerate mode etc.
          *

services/s3/src/test/java/software/amazon/awssdk/services/s3/S3UtilitiesTest.java

@@ -130,6 +130,20 @@ public void test_EndpointOnRequestTakesPrecendence() throws MalformedURLExceptio
             .isEqualTo("https://foo-bucket.s3.amazonaws.com/key-without-spaces");
     }
 
+    @Test
+    public void test_EndpointOverrideOnClientWorks() {
+        S3Utilities customizeUtilities = S3Client.builder()
+                                                 .endpointOverride(URI.create("https://s3.custom.host"))
+                                                 .build()
+                                                 .utilities();
+        assertThat(customizeUtilities.getUrl(GetUrlRequest.builder()
+                                                          .bucket("foo-bucket")
+                                                          .key("key-without-spaces")
+                                                          .build())
+                                     .toExternalForm())
+            .isEqualTo("https://foo-bucket.s3.custom.host/key-without-spaces");
+    }
+
     @Test
     public void testWithAccelerateAndDualStackEnabled() throws MalformedURLException {
         S3Utilities utilities = S3Client.builder()