Add initial AuthSchemeProvider codegen

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

@@ -59,6 +59,7 @@ public static Metadata constructMetadata(ServiceModel serviceModel,
                 .withPaginatorsPackageName(namingStrategy.getPaginatorsPackageName(serviceName))
                 .withWaitersPackageName(namingStrategy.getWaitersPackageName(serviceName))
                 .withEndpointRulesPackageName(namingStrategy.getEndpointRulesPackageName(serviceName))
+                .withAuthSchemePackageName(namingStrategy.getAuthSchemePackageName(serviceName))
                 .withServiceAbbreviation(serviceMetadata.getServiceAbbreviation())
                 .withServiceFullName(serviceMetadata.getServiceFullName())
                 .withServiceName(serviceName)

codegen/src/main/java/software/amazon/awssdk/codegen/emitters/GeneratorPathProvider.java

@@ -95,4 +95,13 @@ public String getEndpointRulesInternalResourcesDirectory() {
     public String getEndpointRulesTestDirectory() {
         return testDirectory + "/" + Utils.packageToDirectory(model.getMetadata().getFullEndpointRulesPackageName());
     }
+
+    public String getAuthSchemeDirectory() {
+        return sourceDirectory + "/" + Utils.packageToDirectory(model.getMetadata().getFullAuthSchemePackageName());
+    }
+
+    public String getAuthSchemeInternalDirectory() {
+        return sourceDirectory + "/" + Utils.packageToDirectory(model.getMetadata().getFullInternalAuthSchemePackageName());
+    }
+
 }

codegen/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/AuthSchemeGeneratorTasks.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 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.emitters.tasks;
+
+import java.util.ArrayList;
+import java.util.List;
+import software.amazon.awssdk.codegen.emitters.GeneratorTask;
+import software.amazon.awssdk.codegen.emitters.GeneratorTaskParams;
+import software.amazon.awssdk.codegen.emitters.PoetGeneratorTask;
+import software.amazon.awssdk.codegen.poet.authscheme.AuthSchemeParamsSpec;
+import software.amazon.awssdk.codegen.poet.authscheme.AuthSchemeProviderSpec;
+import software.amazon.awssdk.codegen.poet.authscheme.DefaultAuthSchemeParamsSpec;
+import software.amazon.awssdk.codegen.poet.authscheme.DefaultAuthSchemeProviderSpec;
+
+public final class AuthSchemeGeneratorTasks extends BaseGeneratorTasks {
+    private final GeneratorTaskParams generatorTaskParams;
+
+    public AuthSchemeGeneratorTasks(GeneratorTaskParams dependencies) {
+        super(dependencies);
+        this.generatorTaskParams = dependencies;
+    }
+
+    @Override
+    protected List<GeneratorTask> createTasks() throws Exception {
+        List<GeneratorTask> tasks = new ArrayList<>();
+        tasks.add(generateParamsInterface());
+        tasks.add(generateProviderInterface());
+        tasks.add(generateDefaultParamsImpl());
+        tasks.add(generateDefaultProviderImpl());
+        return tasks;
+    }
+
+    private GeneratorTask generateParamsInterface() {
+        return new PoetGeneratorTask(authSchemeDir(), model.getFileHeader(), new AuthSchemeParamsSpec(model));
+    }
+
+    private GeneratorTask generateDefaultParamsImpl() {
+        return new PoetGeneratorTask(authSchemeInternalDir(), model.getFileHeader(), new DefaultAuthSchemeParamsSpec(model));
+    }
+
+    private GeneratorTask generateProviderInterface() {
+        return new PoetGeneratorTask(authSchemeDir(), model.getFileHeader(), new AuthSchemeProviderSpec(model));
+    }
+
+    private GeneratorTask generateDefaultProviderImpl() {
+        return new PoetGeneratorTask(authSchemeInternalDir(), model.getFileHeader(), new DefaultAuthSchemeProviderSpec(model));
+    }
+
+    private String authSchemeDir() {
+        return generatorTaskParams.getPathProvider().getAuthSchemeDirectory();
+    }
+
+    private String authSchemeInternalDir() {
+        return generatorTaskParams.getPathProvider().getAuthSchemeInternalDirectory();
+    }
+}

codegen/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/AwsGeneratorTasks.java

@@ -27,6 +27,7 @@ public AwsGeneratorTasks(GeneratorTaskParams params) {
               new PaginatorsGeneratorTasks(params),
               new EventStreamGeneratorTasks(params),
               new WaitersGeneratorTasks(params),
-              new EndpointProviderTasks(params));
+              new EndpointProviderTasks(params),
+              new AuthSchemeGeneratorTasks(params));
     }
 }

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

@@ -70,6 +70,9 @@ public final class Constant {
 
     public static final String PACKAGE_NAME_RULES_PATTERN = "%s.endpoints";
 
+    // TODO: reviewer: maybe just auth instead of authscheme? or auth.scheme?
+    public static final String PACKAGE_NAME_AUTH_SCHEME_PATTERN = "%s.authscheme";
+
     public static final String PACKAGE_NAME_SMOKE_TEST_PATTERN = "%s.smoketests";
 
     public static final String PACKAGE_NAME_CUSTOM_AUTH_PATTERN = "%s.auth";

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

@@ -72,6 +72,8 @@ public class Metadata {
 
     private String endpointRulesPackageName;
 
+    private String authSchemePackageName;
+
     private String serviceAbbreviation;
 
     private String serviceFullName;
@@ -723,6 +725,27 @@ public String getFullInternalEndpointRulesPackageName() {
         return joinPackageNames(getFullEndpointRulesPackageName(), "internal");
     }
 
+    public void setAuthSchemePackageName(String authSchemePackageName) {
+        this.authSchemePackageName = authSchemePackageName;
+    }
+
+    public Metadata withAuthSchemePackageName(String authSchemePackageName) {
+        setAuthSchemePackageName(authSchemePackageName);
+        return this;
+    }
+
+    public String getAuthSchemePackageName() {
+        return authSchemePackageName;
+    }
+
+    public String getFullAuthSchemePackageName() {
+        return joinPackageNames(rootPackageName, getAuthSchemePackageName());
+    }
+
+    public String getFullInternalAuthSchemePackageName() {
+        return joinPackageNames(getFullAuthSchemePackageName(), "internal");
+    }
+
     public String getFullInternalPackageName() {
         return joinPackageNames(getFullClientPackageName(), "internal");
     }

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

@@ -179,6 +179,11 @@ public String getEndpointRulesPackageName(String serviceName) {
         return getCustomizedPackageName(concatServiceNameIfShareModel(serviceName), Constant.PACKAGE_NAME_RULES_PATTERN);
     }
 
+    @Override
+    public String getAuthSchemePackageName(String serviceName) {
+        return getCustomizedPackageName(concatServiceNameIfShareModel(serviceName), Constant.PACKAGE_NAME_AUTH_SCHEME_PATTERN);
+    }
+
     @Override
     public String getSmokeTestPackageName(String serviceName) {
 

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

@@ -18,6 +18,7 @@
 import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
 import software.amazon.awssdk.codegen.model.intermediate.MemberModel;
 import software.amazon.awssdk.codegen.model.service.Shape;
+import software.amazon.awssdk.core.SdkField;
 
 /**
  * Strategy to name various Java constructs based on the naming in the model and potentially customizations.
@@ -63,6 +64,11 @@ public interface NamingStrategy {
      */
     String getEndpointRulesPackageName(String serviceName);
 
+    /**
+     * Retrieve the auth scheme package name that should be used based on the service name.
+     */
+    String getAuthSchemePackageName(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/authscheme/AuthSchemeParamsSpec.java

@@ -0,0 +1,131 @@
+/*
+ * Copyright 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.poet.authscheme;
+
+import com.squareup.javapoet.ClassName;
+import com.squareup.javapoet.CodeBlock;
+import com.squareup.javapoet.MethodSpec;
+import com.squareup.javapoet.ParameterSpec;
+import com.squareup.javapoet.ParameterizedTypeName;
+import com.squareup.javapoet.TypeSpec;
+import java.util.Optional;
+import javax.lang.model.element.Modifier;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
+import software.amazon.awssdk.codegen.poet.ClassSpec;
+import software.amazon.awssdk.codegen.poet.PoetUtils;
+
+// TODO: reviewer: Params v/s Parameters?
+public class AuthSchemeParamsSpec implements ClassSpec {
+    private final IntermediateModel intermediateModel;
+    private final AuthSchemeSpecUtils authSchemeSpecUtils;
+
+    public AuthSchemeParamsSpec(IntermediateModel intermediateModel) {
+        this.intermediateModel = intermediateModel;
+        this.authSchemeSpecUtils = new AuthSchemeSpecUtils(intermediateModel);
+    }
+
+    @Override
+    public ClassName className() {
+        return authSchemeSpecUtils.parametersInterfaceName();
+    }
+
+    @Override
+    public TypeSpec poetSpec() {
+        TypeSpec.Builder b = PoetUtils.createInterfaceBuilder(className())
+                                      .addModifiers(Modifier.PUBLIC)
+                                      .addAnnotation(SdkPublicApi.class)
+                                      .addJavadoc(interfaceJavadoc())
+                                      .addMethod(builderMethod())
+                                      .addType(builderInterfaceSpec());
+
+        addAccessorMethods(b);
+        return b.build();
+    }
+
+    private CodeBlock interfaceJavadoc() {
+        CodeBlock.Builder b = CodeBlock.builder();
+
+        b.add("The parameters object used to resolve the auth schemes for the $N service.",
+              intermediateModel.getMetadata().getServiceName());
+
+        return b.build();
+    }
+
+    private MethodSpec builderMethod() {
+        return MethodSpec.methodBuilder("builder")
+                         .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
+                         .returns(authSchemeSpecUtils.parametersInterfaceBuilderInterfaceName())
+                         .addStatement("return $T.builder()", authSchemeSpecUtils.parametersDefaultImplName())
+                         .addJavadoc("Get a new builder for creating a {@link $T}.",
+                                   authSchemeSpecUtils.parametersInterfaceName())
+                         .build();
+    }
+
+    private TypeSpec builderInterfaceSpec() {
+        TypeSpec.Builder b = TypeSpec.interfaceBuilder(authSchemeSpecUtils.parametersInterfaceBuilderInterfaceName())
+                                     .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
+                                     .addJavadoc("A builder for a {@link $T}.", authSchemeSpecUtils.parametersInterfaceName());
+
+        addBuilderSetterMethods(b);
+
+        b.addMethod(MethodSpec.methodBuilder("build")
+                              .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
+                              .returns(className())
+                              .addJavadoc("Returns a {@link $T} object that is created from the properties that have been set "
+                                          + "on the builder.", authSchemeSpecUtils.parametersInterfaceName())
+                              .build());
+
+        return b.build();
+    }
+
+    private void addAccessorMethods(TypeSpec.Builder b) {
+        b.addMethod(MethodSpec.methodBuilder("operation")
+                              .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
+                              .returns(String.class)
+                              .addJavadoc("Returns the operation for which to resolve the auth scheme.")
+                              .build());
+
+        if (authSchemeSpecUtils.usesSigV4()) {
+            b.addMethod(MethodSpec.methodBuilder("region")
+                                  .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
+                                  // TODO: reviewer: Should region be Regions (Regions.class isn't available here though)
+                                  .returns(ParameterizedTypeName.get(Optional.class, String.class))
+                                  .addJavadoc("Returns the region. The region is optional. The region parameter may be used "
+                                              + "with $S auth scheme. By default, the region will be empty.", "aws.auth#sigv4")
+                                  .build());
+        }
+    }
+
+    private void addBuilderSetterMethods(TypeSpec.Builder b) {
+        b.addMethod(MethodSpec.methodBuilder("operation")
+                              .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
+                              .addParameter(ParameterSpec.builder(String.class, "operation").build())
+                              .returns(authSchemeSpecUtils.parametersInterfaceBuilderInterfaceName())
+                              .addJavadoc("Set the operation for which to resolve the auth scheme.")
+                              .build());
+
+        if (authSchemeSpecUtils.usesSigV4()) {
+            b.addMethod(MethodSpec.methodBuilder("region")
+                                  .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
+                                  .addParameter(ParameterSpec.builder(String.class, "region").build())
+                                  .returns(authSchemeSpecUtils.parametersInterfaceBuilderInterfaceName())
+                                  .addJavadoc("Set the region. The region parameter may be used with  the $S auth scheme.",
+                                              "aws.auth#sigv4") // TODO: Could the known auth schemes be defined somewhere?
+                                  .build());
+        }
+    }
+}