Annotate client interfaces with @threadsafe and @SdkPublicApi.

aws · Apr 27, 2021 · f5916fc · f5916fc
1 parent 69546d5
commit f5916fc
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 0 deletions.
diff --git a/codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/AsyncClientInterface.java b/codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/AsyncClientInterface.java
@@ -32,6 +32,8 @@
 import java.util.stream.Stream;
 import javax.lang.model.element.Modifier;
 import org.reactivestreams.Publisher;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider;
 import software.amazon.awssdk.codegen.docs.ClientType;
 import software.amazon.awssdk.codegen.docs.DocConfiguration;
@@ -76,6 +78,8 @@ public TypeSpec poetSpec() {
         TypeSpec.Builder result = PoetUtils.createInterfaceBuilder(className);
 
         result.addSuperinterface(SdkClient.class)
+              .addAnnotation(SdkPublicApi.class)
+              .addAnnotation(ThreadSafe.class)
               .addField(FieldSpec.builder(String.class, "SERVICE_NAME")
                                  .addModifiers(Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL)
                                  .initializer("$S", model.getMetadata().getSigningName())

diff --git a/codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/SyncClientInterface.java b/codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/SyncClientInterface.java
@@ -34,6 +34,8 @@
 import java.util.List;
 import java.util.function.Consumer;
 import javax.lang.model.element.Modifier;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider;
 import software.amazon.awssdk.awscore.exception.AwsServiceException;
 import software.amazon.awssdk.codegen.docs.ClientType;
@@ -75,7 +77,10 @@ public SyncClientInterface(IntermediateModel model) {
     public TypeSpec poetSpec() {
         TypeSpec.Builder result = PoetUtils.createInterfaceBuilder(className);
 
+
         result.addSuperinterface(SdkClient.class)
+              .addAnnotation(SdkPublicApi.class)
+              .addAnnotation(ThreadSafe.class)
               .addField(FieldSpec.builder(String.class, "SERVICE_NAME")
                                  .addModifiers(Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL)
                                  .initializer("$S", model.getMetadata().getSigningName())

diff --git a/...esources/software/amazon/awssdk/codegen/poet/client/test-json-async-client-interface.java b/...esources/software/amazon/awssdk/codegen/poet/client/test-json-async-client-interface.java
@@ -5,6 +5,8 @@
 import java.util.function.Consumer;
 import org.reactivestreams.Publisher;
 import software.amazon.awssdk.annotations.Generated;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.core.SdkClient;
 import software.amazon.awssdk.core.async.AsyncRequestBody;
 import software.amazon.awssdk.core.async.AsyncResponseTransformer;
@@ -44,6 +46,8 @@
  * A service that is implemented using the query protocol
  */
 @Generated("software.amazon.awssdk:codegen")
+@SdkPublicApi
+@ThreadSafe
 public interface JsonAsyncClient extends SdkClient {
     String SERVICE_NAME = "json-service";
 

diff --git a/...test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-interface.java b/...test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-interface.java
@@ -3,6 +3,8 @@
 import java.nio.file.Path;
 import java.util.function.Consumer;
 import software.amazon.awssdk.annotations.Generated;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.awscore.exception.AwsServiceException;
 import software.amazon.awssdk.core.ResponseBytes;
 import software.amazon.awssdk.core.ResponseInputStream;
@@ -40,6 +42,8 @@
  * A service that is implemented using the query protocol
  */
 @Generated("software.amazon.awssdk:codegen")
+@SdkPublicApi
+@ThreadSafe
 public interface JsonClient extends SdkClient {
     String SERVICE_NAME = "json-service";
 

diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkClient.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkClient.java
@@ -16,12 +16,14 @@
 package software.amazon.awssdk.core;
 
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.utils.SdkAutoCloseable;
 
 /**
  * All SDK service client interfaces should extend this interface.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface SdkClient extends SdkAutoCloseable {
 
     /**