Adding SdkClient interface that all service clients extend from.

Author: kiiadi

.changes/next-release/feature-AWSSDKforJavav2-5750505.json

@@ -0,0 +1,5 @@
+{
+    "category": "AWS SDK for Java v2", 
+    "type": "feature", 
+    "description": "Added `SdkClient` base interface that all service clients implement."
+}

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

@@ -58,6 +58,7 @@ public TypeSpec poetSpec() {
                                         .addSuperinterface(interfaceClass)
                                         .addJavadoc("Internal implementation of {@link $1T}.\n\n@see $1T#builder()",
                                                     interfaceClass)
+                                        .addMethod(nameMethod())
                                         .addMethods(operations())
                                         .addMethod(closeMethod())
                                         .addMethods(protocolSpec.additionalMethods())
@@ -84,6 +85,15 @@ private MethodSpec constructor() {
                          .build();
     }
 
+    private MethodSpec nameMethod() {
+        return MethodSpec.methodBuilder("serviceName")
+                         .addAnnotation(Override.class)
+                         .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
+                         .returns(String.class)
+                         .addStatement("return SERVICE_NAME")
+                         .build();
+    }
+
     private MethodSpec constructorWithAdvancedConfiguration() {
         ClassName advancedConfiguration = ClassName.get(basePackage,
                                                         model.getCustomizationConfig().getServiceSpecificClientConfigClass());

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

@@ -18,6 +18,7 @@
 import static java.util.stream.Collectors.toList;
 
 import com.squareup.javapoet.ClassName;
+import com.squareup.javapoet.FieldSpec;
 import com.squareup.javapoet.MethodSpec;
 import com.squareup.javapoet.ParameterizedTypeName;
 import com.squareup.javapoet.TypeName;
@@ -36,6 +37,7 @@
 import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
 import software.amazon.awssdk.codegen.poet.ClassSpec;
 import software.amazon.awssdk.codegen.poet.PoetUtils;
+import software.amazon.awssdk.core.SdkClient;
 import software.amazon.awssdk.core.async.AsyncRequestProvider;
 import software.amazon.awssdk.core.async.AsyncResponseHandler;
 import software.amazon.awssdk.core.auth.DefaultCredentialsProvider;
@@ -62,8 +64,13 @@ public AsyncClientInterface(IntermediateModel model) {
     @Override
     public TypeSpec poetSpec() {
         return PoetUtils.createInterfaceBuilder(className)
+                        .addSuperinterface(SdkClient.class)
                         .addSuperinterface(SdkAutoCloseable.class)
                         .addJavadoc(getJavadoc())
+                        .addField(FieldSpec.builder(String.class, "SERVICE_NAME")
+                                           .addModifiers(Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL)
+                                           .initializer("$S", model.getMetadata().getSigningName())
+                                           .build())
                         .addMethod(create())
                         .addMethod(builder())
                         .addMethods(operationsAndSimpleMethods())

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

@@ -74,6 +74,7 @@ public TypeSpec poetSpec() {
                                         .addField(ClientHandler.class, "clientHandler", PRIVATE, FINAL)
                                         .addField(protocolSpec.protocolFactory(model))
                                         .addField(ClientConfiguration.class, "clientConfiguration", PRIVATE, FINAL)
+                                        .addMethod(nameMethod())
                                         .addMethods(operations());
 
         if (model.getCustomizationConfig().getServiceSpecificClientConfigClass() != null) {
@@ -93,6 +94,15 @@ public TypeSpec poetSpec() {
         return classBuilder.build();
     }
 
+    private MethodSpec nameMethod() {
+        return MethodSpec.methodBuilder("serviceName")
+                         .addAnnotation(Override.class)
+                         .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
+                         .returns(String.class)
+                         .addStatement("return SERVICE_NAME")
+                         .build();
+    }
+
     @Override
     public ClassName className() {
         return className;

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

@@ -39,6 +39,7 @@
 import software.amazon.awssdk.codegen.poet.PoetExtensions;
 import software.amazon.awssdk.codegen.poet.PoetUtils;
 import software.amazon.awssdk.codegen.utils.PaginatorUtils;
+import software.amazon.awssdk.core.SdkClient;
 import software.amazon.awssdk.core.auth.DefaultCredentialsProvider;
 import software.amazon.awssdk.core.exception.SdkClientException;
 import software.amazon.awssdk.core.exception.SdkServiceException;
@@ -67,6 +68,7 @@ public SyncClientInterface(IntermediateModel model) {
     @Override
     public TypeSpec poetSpec() {
         return PoetUtils.createInterfaceBuilder(className)
+                        .addSuperinterface(SdkClient.class)
                         .addSuperinterface(SdkAutoCloseable.class)
                         .addJavadoc(getJavadoc())
                         .addField(FieldSpec.builder(String.class, "SERVICE_NAME")

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

@@ -63,6 +63,11 @@ protected DefaultJsonAsyncClient(AsyncClientConfiguration clientConfiguration, A
         this.protocolFactory = init();
     }
 
+    @Override
+    public final String serviceName() {
+        return SERVICE_NAME;
+    }
+
     /**
      * <p>
      * Performs a post operation to the query service and has no output

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

@@ -4,6 +4,7 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Consumer;
 import javax.annotation.Generated;
+import software.amazon.awssdk.core.SdkClient;
 import software.amazon.awssdk.core.async.AsyncRequestProvider;
 import software.amazon.awssdk.core.async.AsyncResponseHandler;
 import software.amazon.awssdk.services.json.model.APostOperationRequest;
@@ -29,7 +30,9 @@
  * A service that is implemented using the query protocol
  */
 @Generated("software.amazon.awssdk:codegen")
-public interface JsonAsyncClient extends SdkAutoCloseable {
+public interface JsonAsyncClient extends SdkClient, SdkAutoCloseable {
+    String SERVICE_NAME = "json-service";
+
     /**
      * Create a {@link JsonAsyncClient} with the region loaded from the
      * {@link software.amazon.awssdk.core.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from

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

@@ -71,6 +71,11 @@ protected DefaultJsonClient(SyncClientConfiguration clientConfiguration, Advance
         this.clientConfiguration = clientConfiguration;
     }
 
+    @Override
+    public final String serviceName() {
+        return SERVICE_NAME;
+    }
+
     /**
      * <p>
      * Performs a post operation to the query service and has no output

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

@@ -3,6 +3,7 @@
 import java.nio.file.Path;
 import java.util.function.Consumer;
 import javax.annotation.Generated;
+import software.amazon.awssdk.core.SdkClient;
 import software.amazon.awssdk.core.exception.SdkClientException;
 import software.amazon.awssdk.core.exception.SdkServiceException;
 import software.amazon.awssdk.core.regions.ServiceMetadata;
@@ -36,7 +37,7 @@
  * A service that is implemented using the query protocol
  */
 @Generated("software.amazon.awssdk:codegen")
-public interface JsonClient extends SdkAutoCloseable {
+public interface JsonClient extends SdkClient, SdkAutoCloseable {
     String SERVICE_NAME = "json-service";
 
     /**

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

@@ -48,6 +48,11 @@ protected DefaultQueryClient(SyncClientConfiguration clientConfiguration) {
         this.clientConfiguration = clientConfiguration;
     }
 
+    @Override
+    public final String serviceName() {
+        return SERVICE_NAME;
+    }
+
     /**
      * <p>
      * Performs a post operation to the query service and has no output

core/src/main/java/software/amazon/awssdk/core/SdkClient.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2010-2018 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.core;
+
+/**
+ * All SDK service client interfaces should extend this interface.
+ */
+public interface SdkClient {
+
+    /**
+     * The name of the service.
+     *
+     * @return name for this service.
+     */
+    String serviceName();
+}

http-clients/apache-client/src/main/java/software/amazon/awssdk/http/apache/ApacheHttpClientFactory.java

@@ -30,7 +30,7 @@
 import software.amazon.awssdk.http.apache.internal.conn.ClientConnectionManagerFactory;
 import software.amazon.awssdk.http.apache.internal.conn.SdkConnectionKeepAliveStrategy;
 import software.amazon.awssdk.http.apache.internal.impl.ApacheConnectionManagerFactory;
-import software.amazon.awssdk.http.apache.internal.impl.ApacheSdkClient;
+import software.amazon.awssdk.http.apache.internal.impl.ApacheSdkHttpClient;
 import software.amazon.awssdk.http.apache.internal.impl.ConnectionManagerAwareHttpClient;
 import software.amazon.awssdk.http.apache.internal.utils.ApacheUtils;
 import software.amazon.awssdk.utils.AttributeMap;
@@ -72,7 +72,7 @@ private ConnectionManagerAwareHttpClient createClient(ApacheSdkHttpClientFactory
         //            IdleConnectionReaper.registerConnectionManager(cm, settings.getMaxIdleConnectionTime());
         //        }
 
-        return new ApacheSdkClient(builder.build(), cm);
+        return new ApacheSdkHttpClient(builder.build(), cm);
     }
 
     private void addProxyConfig(HttpClientBuilder builder,

http-clients/apache-client/src/main/java/software/amazon/awssdk/http/apache/internal/impl/ApacheSdkClient.java renamed to http-clients/apache-client/src/main/java/software/amazon/awssdk/http/apache/internal/impl/ApacheSdkHttpClient.java

@@ -30,14 +30,14 @@
 /**
  * An instance of {@link ConnectionManagerAwareHttpClient} that delegates all the requests to the given http client.
  */
-public class ApacheSdkClient implements ConnectionManagerAwareHttpClient {
+public class ApacheSdkHttpClient implements ConnectionManagerAwareHttpClient {
 
     private final HttpClient delegate;
 
     private final HttpClientConnectionManager cm;
 
-    public ApacheSdkClient(final HttpClient delegate,
-                           final HttpClientConnectionManager cm) {
+    public ApacheSdkHttpClient(final HttpClient delegate,
+                               final HttpClientConnectionManager cm) {
         if (delegate == null) {
             throw new IllegalArgumentException("delegate " +
                                                "cannot be null");