Merge branch 'master' into finks/corretto-user-agent

Author: spfink

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

@@ -0,0 +1,5 @@
+{
+    "category": "Amazon S3", 
+    "type": "feature", 
+    "description": "Add support for getUrl operation. The API can be used to generate a URL that represents an object in Amazon S3. The url can only be used to download the object content if the object has public read permissions. Original issue: https://github.com/aws/aws-sdk-java-v2/issues/860"
+}

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

@@ -154,6 +154,11 @@ public class CustomizationConfig {
      */
     private Map<String, String> paginationCustomization;
 
+    /**
+     * Config to generate a utilities() in the low-level client
+     */
+    private UtilitiesMethod utilitiesMethod;
+
     private CustomizationConfig() {
     }
 
@@ -393,4 +398,12 @@ public Map<String, String> getPaginationCustomization() {
     public void setPaginationCustomization(Map<String, String> paginationCustomization) {
         this.paginationCustomization = paginationCustomization;
     }
+
+    public UtilitiesMethod getUtilitiesMethod() {
+        return utilitiesMethod;
+    }
+
+    public void setUtilitiesMethod(UtilitiesMethod utilitiesMethod) {
+        this.utilitiesMethod = utilitiesMethod;
+    }
 }

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

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.codegen.model.config.customization;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Config required to generate the utilities method that returns an instance of
+ * hand-written Utilities class
+ */
+public class UtilitiesMethod {
+
+    public static final String METHOD_NAME = "utilities";
+
+    /** Fqcn of the return type of the operation */
+    private String returnType;
+
+    /**
+     * The utilities method will call a protected create() method in the hand-written Utilities class.
+     * These the ordered list of parameters that needs to be passed to the create method.
+     */
+    private List<String> createMethodParams = new ArrayList<>();
+
+    public String getReturnType() {
+        return returnType;
+    }
+
+    public void setReturnType(String returnType) {
+        this.returnType = returnType;
+    }
+
+    public List<String> getCreateMethodParams() {
+        return createMethodParams;
+    }
+
+    public void setCreateMethodParams(List<String> createMethodParams) {
+        this.createMethodParams = createMethodParams;
+    }
+}

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

@@ -44,6 +44,7 @@
 import software.amazon.awssdk.awscore.client.handler.AwsClientHandlerUtils;
 import software.amazon.awssdk.awscore.eventstream.EventStreamTaggedUnionJsonMarshaller;
 import software.amazon.awssdk.codegen.emitters.GeneratorTaskParams;
+import software.amazon.awssdk.codegen.model.config.customization.UtilitiesMethod;
 import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
 import software.amazon.awssdk.codegen.model.intermediate.MemberModel;
 import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
@@ -115,6 +116,10 @@ public TypeSpec poetSpec() {
             classBuilder.addMethod(applySignerOverrideMethod(poetExtensions, model));
         }
 
+        if (model.getCustomizationConfig().getUtilitiesMethod() != null) {
+            classBuilder.addMethod(utilitiesMethod());
+        }
+
         model.getEndpointOperation().ifPresent(
             o -> classBuilder.addField(EndpointDiscoveryRefreshCache.class, "endpointDiscoveryCache", PRIVATE));
 
@@ -282,4 +287,18 @@ private CodeBlock createEventStreamTaggedUnionJsonMarshaller(ShapeModel eventStr
     private TypeName eventStreamType(ShapeModel shapeModel) {
         return poetExtensions.getModelClass(shapeModel.getShapeName());
     }
+
+    private MethodSpec utilitiesMethod() {
+        UtilitiesMethod config = model.getCustomizationConfig().getUtilitiesMethod();
+        ClassName returnType = PoetUtils.classNameFromFqcn(config.getReturnType());
+
+        return MethodSpec.methodBuilder(UtilitiesMethod.METHOD_NAME)
+                         .returns(returnType)
+                         .addModifiers(Modifier.PUBLIC)
+                         .addAnnotation(Override.class)
+                         .addStatement("return $T.create($L)",
+                                       returnType,
+                                       config.getCreateMethodParams().stream().collect(Collectors.joining(",")))
+                         .build();
+    }
 }

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

@@ -36,6 +36,7 @@
 import software.amazon.awssdk.codegen.docs.ClientType;
 import software.amazon.awssdk.codegen.docs.DocConfiguration;
 import software.amazon.awssdk.codegen.docs.SimpleMethodOverload;
+import software.amazon.awssdk.codegen.model.config.customization.UtilitiesMethod;
 import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
 import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
 import software.amazon.awssdk.codegen.poet.ClassSpec;
@@ -87,6 +88,10 @@ public TypeSpec poetSpec() {
         result.addMethod(builder())
               .addMethods(operationsAndSimpleMethods());
 
+        if (model.getCustomizationConfig().getUtilitiesMethod() != null) {
+            result.addMethod(utilitiesMethod());
+        }
+
         return result.build();
     }
 
@@ -423,4 +428,18 @@ private ParameterizedTypeName completableFutureType(TypeName typeName) {
     private String consumerBuilderJavadoc(OperationModel opModel, SimpleMethodOverload overload) {
         return opModel.getDocs(model, ClientType.ASYNC, overload, new DocConfiguration().isConsumerBuilder(true));
     }
+
+    private MethodSpec utilitiesMethod() {
+        UtilitiesMethod config = model.getCustomizationConfig().getUtilitiesMethod();
+        ClassName returnType = PoetUtils.classNameFromFqcn(config.getReturnType());
+
+        return MethodSpec.methodBuilder(UtilitiesMethod.METHOD_NAME)
+                         .returns(returnType)
+                         .addModifiers(Modifier.PUBLIC)
+                         .addModifiers(Modifier.DEFAULT)
+                         .addStatement("throw new $T()", UnsupportedOperationException.class)
+                         .addJavadoc("Creates an instance of {@link $T} object with the "
+                                     + "configuration set on this client.", returnType)
+                         .build();
+    }
 }

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

@@ -34,6 +34,7 @@
 import software.amazon.awssdk.awscore.client.config.AwsClientOption;
 import software.amazon.awssdk.codegen.docs.SimpleMethodOverload;
 import software.amazon.awssdk.codegen.emitters.GeneratorTaskParams;
+import software.amazon.awssdk.codegen.model.config.customization.UtilitiesMethod;
 import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
 import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
 import software.amazon.awssdk.codegen.model.intermediate.Protocol;
@@ -99,6 +100,10 @@ public TypeSpec poetSpec() {
             classBuilder.addMethod(applySignerOverrideMethod(poetExtensions, model));
         }
 
+        if (model.getCustomizationConfig().getUtilitiesMethod() != null) {
+            classBuilder.addMethod(utilitiesMethod());
+        }
+
         model.getEndpointOperation().ifPresent(
             o -> classBuilder.addField(EndpointDiscoveryRefreshCache.class, "endpointDiscoveryCache", PRIVATE));
 
@@ -219,6 +224,20 @@ private MethodSpec closeMethod() {
                          .build();
     }
 
+    private MethodSpec utilitiesMethod() {
+        UtilitiesMethod config = model.getCustomizationConfig().getUtilitiesMethod();
+        ClassName returnType = PoetUtils.classNameFromFqcn(config.getReturnType());
+
+        return MethodSpec.methodBuilder(UtilitiesMethod.METHOD_NAME)
+                         .returns(returnType)
+                         .addModifiers(Modifier.PUBLIC)
+                         .addAnnotation(Override.class)
+                         .addStatement("return $T.create($L)",
+                                       returnType,
+                                       config.getCreateMethodParams().stream().collect(Collectors.joining(",")))
+                         .build();
+    }
+
     static ProtocolSpec getProtocolSpecs(PoetExtensions poetExtensions, IntermediateModel model) {
         Protocol protocol = model.getMetadata().getProtocol();
         switch (protocol) {

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

@@ -36,6 +36,7 @@
 import software.amazon.awssdk.codegen.docs.ClientType;
 import software.amazon.awssdk.codegen.docs.DocConfiguration;
 import software.amazon.awssdk.codegen.docs.SimpleMethodOverload;
+import software.amazon.awssdk.codegen.model.config.customization.UtilitiesMethod;
 import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
 import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
 import software.amazon.awssdk.codegen.poet.ClassSpec;
@@ -85,9 +86,14 @@ public TypeSpec poetSpec() {
               .addMethods(operations())
               .addMethod(serviceMetadata());
 
+        if (model.getCustomizationConfig().getUtilitiesMethod() != null) {
+            result.addMethod(utilitiesMethod());
+        }
+
         return result.build();
     }
 
+
     @Override
     public ClassName className() {
         return className;
@@ -436,4 +442,18 @@ private static List<ClassName> getExceptionClasses(IntermediateModel model, Oper
     private String consumerBuilderJavadoc(OperationModel opModel, SimpleMethodOverload overload) {
         return opModel.getDocs(model, ClientType.SYNC, overload, new DocConfiguration().isConsumerBuilder(true));
     }
+
+    private MethodSpec utilitiesMethod() {
+        UtilitiesMethod config = model.getCustomizationConfig().getUtilitiesMethod();
+        ClassName returnType = PoetUtils.classNameFromFqcn(config.getReturnType());
+
+        return MethodSpec.methodBuilder(UtilitiesMethod.METHOD_NAME)
+                         .returns(returnType)
+                         .addModifiers(Modifier.PUBLIC)
+                         .addModifiers(Modifier.DEFAULT)
+                         .addStatement("throw new $T()", UnsupportedOperationException.class)
+                         .addJavadoc("Creates an instance of {@link $T} object with the "
+                                     + "configuration set on this client.", returnType)
+                         .build();
+    }
 }

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

@@ -8,5 +8,9 @@
     "verifiedSimpleMethods" : ["paginatedOperationWithResultKey"],
     "blacklistedSimpleMethods" : [
         "eventStreamOperation"
-    ]
+    ],
+  "utilitiesMethod": {
+    "returnType": "software.amazon.awssdk.services.json.JsonUtilities",
+    "createMethodParams": ["param1", "param2", "param3"]
+  }
 }

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-async-client-class.java

@@ -847,6 +847,11 @@ private <T extends JsonRequest> T applySignerOverride(T request, Signer signer)
         return (T) request.toBuilder().overrideConfiguration(overrideConfiguration).build();
     }
 
+    @Override
+    public JsonUtilities utilities() {
+        return JsonUtilities.create(param1, param2, param3);
+    }
+
     private HttpResponseHandler<AwsServiceException> createErrorResponseHandler(BaseAwsJsonProtocolFactory protocolFactory,
             JsonOperationMetadata operationMetadata) {
         return protocolFactory.createErrorResponseHandler(operationMetadata);

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-async-client-interface.java

@@ -1291,4 +1291,11 @@ default CompletableFuture<StreamingOutputOperationResponse> streamingOutputOpera
         return streamingOutputOperation(StreamingOutputOperationRequest.builder().applyMutation(streamingOutputOperationRequest)
                                                                        .build(), destinationPath);
     }
+
+    /**
+     * Creates an instance of {@link JsonUtilities} object with the configuration set on this client.
+     */
+    default JsonUtilities utilities() {
+        throw new UnsupportedOperationException();
+    }
 }

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-class.java

@@ -623,4 +623,9 @@ private <T extends JsonRequest> T applySignerOverride(T request, Signer signer)
                                                                        .orElse((AwsRequestOverrideConfiguration.builder().applyMutation(signerOverride).build()));
         return (T) request.toBuilder().overrideConfiguration(overrideConfiguration).build();
     }
+
+    @Override
+    public JsonUtilities utilities() {
+        return JsonUtilities.create(param1, param2, param3);
+    }
 }

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-interface.java

@@ -1287,4 +1287,11 @@ default ResponseBytes<StreamingOutputOperationResponse> streamingOutputOperation
     static ServiceMetadata serviceMetadata() {
         return ServiceMetadata.of("json-service");
     }
+
+    /**
+     * Creates an instance of {@link JsonUtilities} object with the configuration set on this client.
+     */
+    default JsonUtilities utilities() {
+        throw new UnsupportedOperationException();
+    }
 }

core/sdk-core/src/main/java/software/amazon/awssdk/core/exception/SdkException.java

@@ -33,6 +33,10 @@ protected SdkException(Builder builder) {
         super(builder.message(), builder.cause());
     }
 
+    public static SdkException create(String message, Throwable cause) {
+        return SdkException.builder().message(message).cause(cause).build();
+    }
+
     /**
      * Specifies whether or not an exception can be expected to succeed on a retry.
      */