feat: Add presigned URL download support to S3AsyncClient and S3 Transfer Manager

.changes/next-release/feature-AmazonS3-a6f238d.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon S3",
+    "description": "Add presigned URL download support to S3AsyncClient and S3 Transfer Manager. Customers can now download S3 objects using pre-signed URLs through the SDK's async client pipeline without needing AWS credentials configured.",
+    "contributor": ""
+}

codegen/src/main/java/software/amazon/awssdk/codegen/AddMetadata.java

@@ -62,6 +62,7 @@ public static Metadata constructMetadata(ServiceModel serviceModel,
                 .withDocumentation(serviceModel.getDocumentation())
                 .withServiceAbbreviation(serviceMetadata.getServiceAbbreviation())
                 .withBatchmanagerPackageName(namingStrategy.getBatchManagerPackageName(serviceName))
+                .withPresignedUrlPackageName(namingStrategy.getPresignedUrlPackageName(serviceName))
                 .withServiceFullName(serviceMetadata.getServiceFullName())
                 .withServiceName(serviceName)
                 .withSyncClient(String.format(Constant.SYNC_CLIENT_CLASS_NAME_PATTERN, serviceName))

codegen/src/main/java/software/amazon/awssdk/codegen/internal/Constant.java

@@ -78,6 +78,8 @@ public final class Constant {
 
     public static final String PACKAGE_NAME_BATCHMANAGER_PATTERN = "%s.batchmanager";
 
+    public static final String PACKAGE_NAME_PRESIGNEDURL_PATTERN = "%s.presignedurl";
+
     public static final String PACKAGE_NAME_CUSTOM_AUTH_PATTERN = "%s.auth";
 
     public static final String AUTH_POLICY_ENUM_CLASS_DIR = "software/amazon/awssdk/auth/policy/actions";

codegen/src/main/java/software/amazon/awssdk/codegen/model/config/customization/CustomizationConfig.java

@@ -351,6 +351,11 @@ public class CustomizationConfig {
      */
     private boolean batchManagerSupported;
 
+    /**
+     * A boolean flag to indicate if Presigned URL Extension is supported.
+     */
+    private boolean presignedUrlExtensionSupported;
+
     /**
      * A boolean flag to indicate if the fast unmarshaller code path is enabled.
      */
@@ -951,6 +956,14 @@ public void setBatchManagerSupported(boolean batchManagerSupported) {
         this.batchManagerSupported = batchManagerSupported;
     }
 
+    public boolean getPresignedUrlExtensionSupported() {
+        return presignedUrlExtensionSupported;
+    }
+
+    public void setPresignedUrlExtensionSupported(boolean presignedUrlExtensionSupported) {
+        this.presignedUrlExtensionSupported = presignedUrlExtensionSupported;
+    }
+
     public boolean getEnableFastUnmarshaller() {
         return enableFastUnmarshaller;
     }

codegen/src/main/java/software/amazon/awssdk/codegen/model/intermediate/Metadata.java

@@ -73,6 +73,8 @@ public class Metadata {
 
     private String batchManagerPackageName;
 
+    private String presignedUrlPackageName;
+
     private String endpointRulesPackageName;
 
     private String authSchemePackageName;
@@ -815,4 +817,20 @@ public String getFullBatchManagerPackageName() {
         return joinPackageNames(rootPackageName, getBatchManagerPackageName());
     }
 
+    public Metadata withPresignedUrlPackageName(String presignedUrlPackageName) {
+        setPresignedUrlPackageName(presignedUrlPackageName);
+        return this;
+    }
+
+    public String getPresignedUrlPackageName() {
+        return presignedUrlPackageName;
+    }
+
+    public void setPresignedUrlPackageName(String presignedUrlPackageName) {
+        this.presignedUrlPackageName = presignedUrlPackageName;
+    }
+
+    public String getFullPresignedUrlPackageName() {
+        return joinPackageNames(rootPackageName, getPresignedUrlPackageName());
+    }
 }

codegen/src/main/java/software/amazon/awssdk/codegen/naming/DefaultNamingStrategy.java

@@ -220,6 +220,11 @@ public String getJmesPathPackageName(String serviceName) {
     public String getBatchManagerPackageName(String serviceName) {
         return getCustomizedPackageName(concatServiceNameIfShareModel(serviceName), Constant.PACKAGE_NAME_BATCHMANAGER_PATTERN);
     }
+
+    @Override
+    public String getPresignedUrlPackageName(String serviceName) {
+        return getCustomizedPackageName(concatServiceNameIfShareModel(serviceName), Constant.PACKAGE_NAME_PRESIGNEDURL_PATTERN);
+    }
 
     @Override
     public String getSmokeTestPackageName(String serviceName) {

codegen/src/main/java/software/amazon/awssdk/codegen/naming/NamingStrategy.java

@@ -93,6 +93,11 @@ public interface NamingStrategy {
      * Retrieve the batchManager package name that should be used based on the service name.
      */
     String getBatchManagerPackageName(String serviceName);
+
+    /**
+     * Retrieve the presignedUrl package name that should be used based on the service name.
+     */
+    String getPresignedUrlPackageName(String serviceName);
 
     /**
      * Retrieve the smote test package name that should be used based on the service name.

codegen/src/main/java/software/amazon/awssdk/codegen/poet/PoetExtension.java

@@ -209,4 +209,8 @@ public ClassName getBatchManagerAsyncInterface() {
         return ClassName.get(model.getMetadata().getFullBatchManagerPackageName(),
                              model.getMetadata().getServiceName() + "AsyncBatchManager");
     }
+
+    public ClassName getPresignedUrlExtensionAsyncInterface() {
+        return ClassName.get(model.getMetadata().getFullPresignedUrlPackageName(), "AsyncPresignedUrlExtension");
+    }
 }

codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/AsyncClientClass.java

@@ -548,6 +548,26 @@ protected void addBatchManagerMethod(Builder type) {
 
         type.addMethod(batchManager);
     }
+
+    @Override
+    protected void addPresignedUrlExtensionMethod(Builder type) {
+        ClassName returnType = poetExtensions.getPresignedUrlExtensionAsyncInterface();
+        String internalPresignedUrlPackage = model.getMetadata().getFullInternalPackageName() + ".presignedurl";
+        ClassName implClass = ClassName.get(internalPresignedUrlPackage, "DefaultAsyncPresignedUrlExtension");
+
+        MethodSpec presignedUrlExtension = MethodSpec.methodBuilder("presignedUrlExtension")
+                                                  .addModifiers(PUBLIC)
+                                                  .addAnnotation(Override.class)
+                                                  .returns(returnType)
+                                                  .addStatement("return new $T(clientHandler,"
+                                                                + " protocolFactory, "
+                                                                + "clientConfiguration,"
+                                                                + " protocolMetadata)",
+                                                                implClass)
+                                                  .build();
+
+        type.addMethod(presignedUrlExtension);
+    }
 
     private MethodSpec resolveMetricPublishersMethod() {
         String clientConfigName = "clientConfiguration";

codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/AsyncClientInterface.java

@@ -99,6 +99,9 @@ public TypeSpec poetSpec() {
         if (model.getCustomizationConfig().getBatchManagerSupported()) {
             addBatchManagerMethod(result);
         }
+        if (model.getCustomizationConfig().getPresignedUrlExtensionSupported()) {
+            addPresignedUrlExtensionMethod(result);
+        }
         result.addMethod(serviceClientConfigMethod());
         addAdditionalMethods(result);
         addCloseMethod(result);
@@ -174,6 +177,16 @@ protected void addBatchManagerMethod(TypeSpec.Builder type) {
                                                            + "configuration set on this client.", returnType);
         type.addMethod(batchManagerOperationBody(builder).build());
     }
+
+    protected void addPresignedUrlExtensionMethod(TypeSpec.Builder type) {
+        ClassName returnType = poetExtensions.getPresignedUrlExtensionAsyncInterface();
+        MethodSpec.Builder builder = MethodSpec.methodBuilder("presignedUrlExtension")
+                                               .addModifiers(PUBLIC)
+                                               .returns(returnType)
+                                               .addJavadoc("Creates an instance of {@link $T} object with the "
+                                                           + "configuration set on this client.", returnType);
+        type.addMethod(presignedUrlExtensionOperationBody(builder).build());
+    }
 
     @Override
     public ClassName className() {
@@ -550,5 +563,10 @@ protected MethodSpec.Builder batchManagerOperationBody(MethodSpec.Builder builde
         return builder.addModifiers(DEFAULT, PUBLIC)
                       .addStatement("throw new $T()", UnsupportedOperationException.class);
     }
+
+    protected MethodSpec.Builder presignedUrlExtensionOperationBody(MethodSpec.Builder builder) {
+        return builder.addModifiers(DEFAULT, PUBLIC)
+                      .addStatement("throw new $T()", UnsupportedOperationException.class);
+    }
 
 }

codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/DelegatingAsyncClientClass.java

@@ -222,4 +222,9 @@ protected MethodSpec.Builder waiterOperationBody(MethodSpec.Builder builder) {
     protected MethodSpec.Builder batchManagerOperationBody(MethodSpec.Builder builder) {
         return builder.addAnnotation(Override.class).addStatement("return delegate.batchManager()");
     }
+
+    @Override
+    protected MethodSpec.Builder presignedUrlExtensionOperationBody(MethodSpec.Builder builder) {
+        return builder.addAnnotation(Override.class).addStatement("return delegate.presignedUrlExtension()");
+    }
 }

codegen/src/test/java/software/amazon/awssdk/codegen/poet/ClientTestModels.java

@@ -605,6 +605,18 @@ public static IntermediateModel batchManagerModels() {
 
         return new IntermediateModelBuilder(models).build();
     }
+
+    public static IntermediateModel presignedUrlExtensionModels() {
+        File serviceModel = new File(ClientTestModels.class.getResource("client/c2j/presignedurl/service-2.json").getFile());
+        File customizationModel = new File(ClientTestModels.class.getResource("client/c2j/presignedurl/customization.config").getFile());
+
+        C2jModels models = C2jModels.builder()
+                                    .serviceModel(getServiceModel(serviceModel))
+                                    .customizationConfig(getCustomizationConfig(customizationModel))
+                                    .build();
+
+        return new IntermediateModelBuilder(models).build();
+    }
 
     private static ServiceModel getServiceModel(File file) {
         return ModelLoaderUtils.loadModel(ServiceModel.class, file);

codegen/src/test/java/software/amazon/awssdk/codegen/poet/client/AsyncClientClassTest.java

@@ -24,6 +24,7 @@
 import static software.amazon.awssdk.codegen.poet.ClientTestModels.customPackageModels;
 import static software.amazon.awssdk.codegen.poet.ClientTestModels.endpointDiscoveryModels;
 import static software.amazon.awssdk.codegen.poet.ClientTestModels.opsWithSigv4a;
+import static software.amazon.awssdk.codegen.poet.ClientTestModels.presignedUrlExtensionModels;
 import static software.amazon.awssdk.codegen.poet.ClientTestModels.serviceWithCustomContextParamsModels;
 import static software.amazon.awssdk.codegen.poet.ClientTestModels.queryServiceModels;
 import static software.amazon.awssdk.codegen.poet.ClientTestModels.restJsonServiceModels;
@@ -102,6 +103,12 @@ public void asyncClientBatchManager() {
         ClassSpec aSyncClientBatchManager = createAsyncClientClass(batchManagerModels());
         assertThat(aSyncClientBatchManager, generatesTo("test-batchmanager-async.java"));
     }
+
+    @Test
+    public void asyncClientPresignedUrlExtension() {
+        ClassSpec asyncClientPresignedUrlExtension = createAsyncClientClass(presignedUrlExtensionModels());
+        assertThat(asyncClientPresignedUrlExtension, generatesTo("test-presignedurl-async.java"));
+    }
 
     @Test
     public void asyncClientWithStreamingUnsignedPayload() {

codegen/src/test/java/software/amazon/awssdk/codegen/poet/client/AsyncClientInterfaceTest.java

@@ -17,6 +17,7 @@
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static software.amazon.awssdk.codegen.poet.ClientTestModels.batchManagerModels;
+import static software.amazon.awssdk.codegen.poet.ClientTestModels.presignedUrlExtensionModels;
 import static software.amazon.awssdk.codegen.poet.ClientTestModels.restJsonServiceModels;
 import static software.amazon.awssdk.codegen.poet.PoetMatchers.generatesTo;
 
@@ -35,4 +36,10 @@ public void asyncClientInterfaceWithBatchManager() {
         ClassSpec asyncClientInterface = new AsyncClientInterface(batchManagerModels());
         assertThat(asyncClientInterface, generatesTo("test-json-async-client-interface-batchmanager.java"));
     }
+
+    @Test
+    public void asyncClientInterfaceWithPresignedUrlExtension() {
+        ClassSpec asyncClientInterface = new AsyncClientInterface(presignedUrlExtensionModels());
+        assertThat(asyncClientInterface, generatesTo("test-json-async-client-interface-presignedurl.java"));
+    }
 }

codegen/src/test/java/software/amazon/awssdk/codegen/poet/client/DelegatingAsyncClientClassTest.java

@@ -16,6 +16,7 @@
 package software.amazon.awssdk.codegen.poet.client;
 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static software.amazon.awssdk.codegen.poet.ClientTestModels.presignedUrlExtensionModels;
 import static software.amazon.awssdk.codegen.poet.ClientTestModels.restJsonServiceModels;
 import static software.amazon.awssdk.codegen.poet.PoetMatchers.generatesTo;
 
@@ -28,4 +29,11 @@ public void delegatingAsyncClientClass() {
             new DelegatingAsyncClientClass(restJsonServiceModels());
         assertThat(asyncClientDecoratorAbstractClass, generatesTo("test-abstract-async-client-class.java"));
     }
+
+    @Test
+    public void delegatingAsyncClientClassWithPresignedUrlExtension() {
+        DelegatingAsyncClientClass asyncClientDecoratorAbstractClass =
+            new DelegatingAsyncClientClass(presignedUrlExtensionModels());
+        assertThat(asyncClientDecoratorAbstractClass, generatesTo("test-abstract-async-client-class-presignedurl.java"));
+    }
 }

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/c2j/presignedurl/customization.config

@@ -0,0 +1,3 @@
+{
+  "presignedUrlExtensionSupported": true
+}

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/c2j/presignedurl/service-2.json

@@ -0,0 +1,62 @@
+{
+  "version": "2.0",
+  "metadata": {
+    "apiVersion": "2010-05-08",
+    "endpointPrefix": "json-service-endpoint",
+    "globalEndpoint": "json-service.amazonaws.com",
+    "protocol": "json",
+    "serviceAbbreviation": "Json Service",
+    "serviceFullName": "Some Service That Uses AWS Json Protocol",
+    "serviceId": "Json Service",
+    "signingName": "json-service",
+    "signatureVersion": "v4",
+    "uid": "json-service-2010-05-08",
+    "xmlNamespace": "https://json-service.amazonaws.com/doc/2010-05-08/"
+  },
+  "operations": {
+    "APostOperation": {
+      "name": "APostOperation",
+      "http": {
+        "method": "POST",
+        "requestUri": "/"
+      },
+      "input": {
+        "shape": "APostOperationRequest"
+      },
+      "errors": [
+        {
+          "shape": "InvalidInputException"
+        }
+      ],
+      "documentation": "<p>Performs a post operation to the query service and has no output</p>"
+    }
+  },
+  "shapes": {
+    "APostOperationRequest": {
+      "type": "structure",
+      "required": [
+        "StringMember"
+      ],
+      "members": {
+        "StringMember": {
+          "shape": "String",
+          "documentation": "<p>String member</p>"
+        }
+      }
+    },
+    "InvalidInputException": {
+      "type": "structure",
+      "members": {
+        "message": {
+          "shape": "String"
+        }
+      },
+      "documentation": "<p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>",
+      "exception": true
+    },
+    "String": {
+      "type": "string"
+    }
+  },
+  "documentation": "A service that is implemented using the json protocol"
+}