Add @threadsafe or @NotThreadSafe annotations to each @SdkPublicApi in dynamodb-enhanced. (#3136)

Author: millems

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/AttributeConverterProvider.java

@@ -16,6 +16,7 @@
 package software.amazon.awssdk.enhanced.dynamodb;
 
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.enhanced.dynamodb.internal.converter.ConverterProviderResolver;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 
@@ -24,6 +25,7 @@
  * converting a given {@link EnhancedType}.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface AttributeConverterProvider {
 
     /**

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/AttributeValueType.java

@@ -16,9 +16,11 @@
 package software.amazon.awssdk.enhanced.dynamodb;
 
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.services.dynamodb.model.ScalarAttributeType;
 
 @SdkPublicApi
+@ThreadSafe
 public enum AttributeValueType {
     B(ScalarAttributeType.B),        // binary
     BOOL,                            // boolean

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DefaultAttributeConverterProvider.java

@@ -22,6 +22,7 @@
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 import software.amazon.awssdk.annotations.Immutable;
+import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.enhanced.dynamodb.internal.converter.PrimitiveConverter;
@@ -249,6 +250,7 @@ private static Builder getDefaultBuilder() {
     /**
      * A builder for configuring and creating {@link DefaultAttributeConverterProvider}s.
      */
+    @NotThreadSafe
     public static class Builder {
         private List<AttributeConverter<?>> converters = new ArrayList<>();
 

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/Document.java

@@ -16,13 +16,15 @@
 package software.amazon.awssdk.enhanced.dynamodb;
 
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 
 /**
  * A document representing a table item in the form of a map containing attributes and values.
  * <p>
  * Use the {@link #getItem(MappedTableResource)} method to transform the collection of attributes into a typed item.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface Document {
 
     /**

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbAsyncIndex.java

@@ -17,6 +17,7 @@
 
 import java.util.function.Consumer;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.core.async.SdkPublisher;
 import software.amazon.awssdk.enhanced.dynamodb.model.Page;
 import software.amazon.awssdk.enhanced.dynamodb.model.QueryConditional;
@@ -33,6 +34,7 @@
  * @param <T> The type of the modelled object.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface DynamoDbAsyncIndex<T> {
 
     /**

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbAsyncTable.java

@@ -18,6 +18,7 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Consumer;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.enhanced.dynamodb.model.CreateTableEnhancedRequest;
 import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest;
 import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedResponse;
@@ -47,6 +48,7 @@
  * @param <T> The type of the modelled object.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface DynamoDbAsyncTable<T> extends MappedTableResource<T> {
     /**
      * Returns a mapped index that can be used to execute commands against a secondary index belonging to the table

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedAsyncClient.java

@@ -18,7 +18,9 @@
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Consumer;
+import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.core.async.SdkPublisher;
 import software.amazon.awssdk.enhanced.dynamodb.internal.client.DefaultDynamoDbEnhancedAsyncClient;
 import software.amazon.awssdk.enhanced.dynamodb.model.BatchGetItemEnhancedRequest;
@@ -42,6 +44,7 @@
  * implementing classes.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface DynamoDbEnhancedAsyncClient extends DynamoDbEnhancedResource {
 
     /**
@@ -441,6 +444,7 @@ static DynamoDbEnhancedAsyncClient create() {
     /**
      * The builder definition for a {@link DynamoDbEnhancedAsyncClient}.
      */
+    @NotThreadSafe
     interface Builder extends DynamoDbEnhancedResource.Builder {
         /**
          * The regular low-level SDK client to use with the enhanced client.

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedClient.java

@@ -17,7 +17,9 @@
 
 import java.util.List;
 import java.util.function.Consumer;
+import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.core.pagination.sync.SdkIterable;
 import software.amazon.awssdk.enhanced.dynamodb.internal.client.DefaultDynamoDbEnhancedClient;
 import software.amazon.awssdk.enhanced.dynamodb.model.BatchGetItemEnhancedRequest;
@@ -42,6 +44,7 @@
  * implementing classes.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface DynamoDbEnhancedClient extends DynamoDbEnhancedResource {
 
     /**
@@ -443,6 +446,7 @@ static DynamoDbEnhancedClient create() {
     /**
      * The builder definition for a {@link DynamoDbEnhancedClient}.
      */
+    @NotThreadSafe
     interface Builder extends DynamoDbEnhancedResource.Builder {
         /**
          * The regular low-level SDK client to use with the enhanced client.

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedClientExtension.java

@@ -16,6 +16,7 @@
 package software.amazon.awssdk.enhanced.dynamodb;
 
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.enhanced.dynamodb.extensions.ReadModification;
 import software.amazon.awssdk.enhanced.dynamodb.extensions.WriteModification;
 
@@ -29,6 +30,7 @@
  * calculation.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface DynamoDbEnhancedClientExtension {
     /**
      * This hook is called just before an operation is going to write data to the database. The extension that

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedResource.java

@@ -16,18 +16,22 @@
 package software.amazon.awssdk.enhanced.dynamodb;
 
 import java.util.List;
+import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 
 /**
  * Shared interface components for {@link DynamoDbEnhancedClient} and {@link DynamoDbEnhancedAsyncClient}. Any common
  * methods implemented by both of those classes or their builders are declared here.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface DynamoDbEnhancedResource {
     /**
      * Shared interface components for the builders of {@link DynamoDbEnhancedClient} and
      * {@link DynamoDbEnhancedAsyncClient}
      */
+    @NotThreadSafe
     interface Builder {
         /**
          * Specifies the extensions to load with the enhanced client. The extensions will be loaded in the strict order

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbExtensionContext.java

@@ -17,18 +17,21 @@
 
 import java.util.Map;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.enhanced.dynamodb.internal.operations.OperationName;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 
 /**
  * A wrapper for the immutable context objects that are visible to the {@link DynamoDbEnhancedClientExtension}s.
  */
 @SdkPublicApi
+@ThreadSafe
 public final class DynamoDbExtensionContext {
     private DynamoDbExtensionContext() {
     }
 
     @SdkPublicApi
+    @ThreadSafe
     public interface Context {
         /**
          * @return The {@link AttributeValue} map of the items that is about to be written or has just been read.
@@ -57,6 +60,7 @@ default TableSchema<?> tableSchema() {
      * The state of the execution when the {@link DynamoDbEnhancedClientExtension#beforeWrite} method is invoked.
      */
     @SdkPublicApi
+    @ThreadSafe
     public interface BeforeWrite extends Context {
 
         /**
@@ -69,6 +73,7 @@ public interface BeforeWrite extends Context {
      * The state of the execution when the {@link DynamoDbEnhancedClientExtension#afterRead} method is invoked.
      */
     @SdkPublicApi
+    @ThreadSafe
     public interface AfterRead extends Context {
     }
 }

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbIndex.java

@@ -17,6 +17,7 @@
 
 import java.util.function.Consumer;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.core.pagination.sync.SdkIterable;
 import software.amazon.awssdk.enhanced.dynamodb.model.Page;
 import software.amazon.awssdk.enhanced.dynamodb.model.QueryConditional;
@@ -33,6 +34,7 @@
  * @param <T> The type of the modelled object.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface DynamoDbIndex<T> {
 
     /**

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbTable.java

@@ -17,6 +17,7 @@
 
 import java.util.function.Consumer;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.core.pagination.sync.SdkIterable;
 import software.amazon.awssdk.enhanced.dynamodb.model.CreateTableEnhancedRequest;
 import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest;
@@ -47,6 +48,7 @@
  * @param <T> The type of the modelled object.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface DynamoDbTable<T> extends MappedTableResource<T> {
     /**
      * Returns a mapped index that can be used to execute commands against a secondary index belonging to the table

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/EnhancedTypeDocumentConfiguration.java

@@ -16,14 +16,17 @@
 package software.amazon.awssdk.enhanced.dynamodb;
 
 
+import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.utils.builder.CopyableBuilder;
 import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
 
 /**
  * Configuration for {@link EnhancedType} of document type
  */
 @SdkPublicApi
+@ThreadSafe
 public final class EnhancedTypeDocumentConfiguration implements ToCopyableBuilder<EnhancedTypeDocumentConfiguration.Builder,
     EnhancedTypeDocumentConfiguration> {
     private final boolean preserveEmptyObject;
@@ -82,6 +85,7 @@ public static Builder builder() {
         return new Builder();
     }
 
+    @NotThreadSafe
     public static final class Builder implements CopyableBuilder<Builder, EnhancedTypeDocumentConfiguration> {
         private Boolean preserveEmptyObject;
         private Boolean ignoreNulls;

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/Expression.java

@@ -18,7 +18,9 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
+import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 
 /**
@@ -42,6 +44,7 @@
  * }
  */
 @SdkPublicApi
+@ThreadSafe
 public final class Expression {
     private final String expression;
     private final Map<String, AttributeValue> expressionValues;
@@ -218,6 +221,7 @@ public int hashCode() {
     /**
      * A builder for {@link Expression}
      */
+    @NotThreadSafe
     public static final class Builder {
         private String expression;
         private Map<String, AttributeValue> expressionValues;

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/IndexMetadata.java

@@ -17,11 +17,13 @@
 
 import java.util.Optional;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 
 /**
  * A metadata class that stores information about an index
  */
 @SdkPublicApi
+@ThreadSafe
 public interface IndexMetadata {
     /**
      * The name of the index

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/Key.java

@@ -21,7 +21,9 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
+import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.core.SdkBytes;
 import software.amazon.awssdk.enhanced.dynamodb.internal.AttributeValues;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
@@ -36,6 +38,7 @@
  * The names of the keys themselves are not part of this object.
  */
 @SdkPublicApi
+@ThreadSafe
 public final class Key {
     private final AttributeValue partitionValue;
     private final AttributeValue sortValue;
@@ -111,6 +114,7 @@ public Builder toBuilder() {
     /**
      * Builder for {@link Key}
      */
+    @NotThreadSafe
     public static final class Builder {
         private AttributeValue partitionValue;
         private AttributeValue sortValue;

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/KeyAttributeMetadata.java

@@ -16,11 +16,13 @@
 package software.amazon.awssdk.enhanced.dynamodb;
 
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 
 /**
  * A metadata class that stores information about a key attribute
  */
 @SdkPublicApi
+@ThreadSafe
 public interface KeyAttributeMetadata {
     /**
      * The name of the key attribute

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/MappedTableResource.java

@@ -16,6 +16,7 @@
 package software.amazon.awssdk.enhanced.dynamodb;
 
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.annotations.ThreadSafe;
 
 /**
  * Interface for a resource object that is part of either a {@link DynamoDbTable} or {@link DynamoDbAsyncTable}. This
@@ -26,6 +27,7 @@
  * @param <T> The type of the modelled object.
  */
 @SdkPublicApi
+@ThreadSafe
 public interface MappedTableResource<T> {
     /**
      * Gets the {@link DynamoDbEnhancedClientExtension} associated with this mapped resource.