Mark client side encryption as beta

JAVA-3071
JAVA-3377

Author: jyemin

docs/reference/content/driver-async/tutorials/client-side-encryption.md

@@ -17,6 +17,10 @@ With field level encryption, developers can encrypt fields client side without a
 configuration or directives. Client-side field level encryption supports workloads where applications must guarantee that 
 unauthorized parties, including server administrators, cannot read the encrypted data.
 
+{{% note class="important" %}}
+Support for client side encryption is in beta.  Backwards-breaking changes may be made before the final release.
+{{% /note %}}
+
 {{% note class="important" %}}
 Java 8 is the minimum required version that supports Async client side encryption. 
 {{% /note %}}

docs/reference/content/driver/tutorials/client-side-encryption.md

@@ -17,6 +17,10 @@ With field level encryption, developers can encrypt fields client side without a
 configuration or directives. Client-side field level encryption supports workloads where applications must guarantee that 
 unauthorized parties, including server administrators, cannot read the encrypted data.
 
+{{% note class="important" %}}
+Support for client side encryption is in beta.  Backwards-breaking changes may be made before the final release.
+{{% /note %}}
+
 ## Installation
 
 The recommended way to get started using field level encryption in your project is with a dependency management system. 

driver-async/src/main/com/mongodb/async/client/vault/ClientEncryption.java

@@ -16,6 +16,7 @@
 
 package com.mongodb.async.client.vault;
 
+import com.mongodb.annotations.Beta;
 import com.mongodb.async.SingleResultCallback;
 import com.mongodb.client.model.vault.DataKeyOptions;
 import com.mongodb.client.model.vault.EncryptOptions;
@@ -29,8 +30,12 @@
  * <p>
  * Used to create data encryption keys, and to explicitly encrypt and decrypt values when auto-encryption is not an option.
  * </p>
+ * <p>
+ * Note: support for client-side encryption is in beta.  Backwards-breaking changes may be made before the final release.
+ * </p>
  * @since 3.11
  */
+@Beta
 public interface ClientEncryption extends Closeable {
 
     /**

driver-async/src/main/com/mongodb/async/client/vault/ClientEncryptions.java

@@ -17,12 +17,17 @@
 package com.mongodb.async.client.vault;
 
 import com.mongodb.ClientEncryptionSettings;
+import com.mongodb.annotations.Beta;
 
 /**
  * Factory for ClientEncryption implementations.
  *
+ * <p>
+ * Note: support for client side encryption is in beta.  Backwards-breaking changes may be made before the final release.
+ * </p>
  * @since 3.11
  */
+@Beta
 public final class ClientEncryptions {
 
     /**

driver-core/src/main/com/mongodb/AutoEncryptionSettings.java

@@ -16,6 +16,7 @@
 
 package com.mongodb;
 
+import com.mongodb.annotations.Beta;
 import com.mongodb.annotations.NotThreadSafe;
 import com.mongodb.lang.Nullable;
 import org.bson.BsonDocument;
@@ -51,9 +52,13 @@
  * <p>
  * Automatic encryption requires the authenticated user to have the listCollections privilege action.
  * </p>
+ * <p>
+ * Note: support for client side encryption is in beta.  Backwards-breaking changes may be made before the final release.
+ * </p>
  *
  * @since 3.11
  */
+@Beta
 public final class AutoEncryptionSettings {
     private final MongoClientSettings keyVaultMongoClientSettings;
     private final String keyVaultNamespace;
@@ -67,6 +72,7 @@ public final class AutoEncryptionSettings {
      * construction through chaining.
      */
     @NotThreadSafe
+    @Beta
     public static final class Builder {
         private MongoClientSettings keyVaultMongoClientSettings;
         private String keyVaultNamespace;

driver-core/src/main/com/mongodb/ClientEncryptionSettings.java

@@ -16,6 +16,7 @@
 
 package com.mongodb;
 
+import com.mongodb.annotations.Beta;
 import com.mongodb.annotations.NotThreadSafe;
 
 import java.util.Map;
@@ -29,9 +30,14 @@
  * Explicit encryption/decryption is a community feature, enabled with the new {@code com.mongodb.client.vault.ClientEncryption} type,
  * for which this is the settings.
  * </p>
+ * <p>
+ * Note: support for client side encryption is in beta.  Backwards-breaking changes may be made before the final
+ * release.
+ * </p>
  *
  * @since 3.11
  */
+@Beta
 public final class ClientEncryptionSettings {
     private final MongoClientSettings keyVaultMongoClientSettings;
     private final String keyVaultNamespace;

driver-core/src/main/com/mongodb/MongoClientSettings.java

@@ -16,6 +16,7 @@
 
 package com.mongodb;
 
+import com.mongodb.annotations.Beta;
 import com.mongodb.annotations.Immutable;
 import com.mongodb.annotations.NotThreadSafe;
 import com.mongodb.client.gridfs.codecs.GridFSFileCodecProvider;
@@ -439,11 +440,15 @@ public Builder compressorList(final List<MongoCompressor> compressorList) {
         /**
          * Sets the auto-encryption settings
          *
+         * <p>
+         * Note: support for client side encryption is in beta.  Backwards-breaking changes may be made before the final release.
+         * </p>
          * @param autoEncryptionSettings the auto-encryption settings
          * @return this
          * @since 3.11
          * @see #getAutoEncryptionSettings()
          */
+        @Beta
         public Builder autoEncryptionSettings(final AutoEncryptionSettings autoEncryptionSettings) {
             this.autoEncryptionSettings = autoEncryptionSettings;
             return this;
@@ -603,11 +608,15 @@ public List<MongoCompressor> getCompressorList() {
      * <p>
      * Automatic encryption requires the authenticated user to have the listCollections privilege action.
      * </p>
+     * <p>
+     * Note: support for client side encryption is in beta.  Backwards-breaking changes may be made before the final release.
+     * </p>
      *
      * @return the auto-encryption settings, which may be null
      * @since 3.11
      */
     @Nullable
+    @Beta
     public AutoEncryptionSettings getAutoEncryptionSettings() {
         return autoEncryptionSettings;
     }

driver-legacy/src/main/com/mongodb/MongoClientOptions.java

@@ -16,6 +16,7 @@
 
 package com.mongodb;
 
+import com.mongodb.annotations.Beta;
 import com.mongodb.annotations.Immutable;
 import com.mongodb.annotations.NotThreadSafe;
 import com.mongodb.connection.ConnectionPoolSettings;
@@ -741,10 +742,14 @@ public boolean isCursorFinalizerEnabled() {
     /**
      * Gets the auto-encryption settings
      *
+     * <p>
+     * Note: support for client side encryption is in beta.  Backwards-breaking changes may be made before the final release.
+     * </p>
      * @return the auto-encryption settings, which may be null
      * @since 3.11
      */
     @Nullable
+    @Beta
     public AutoEncryptionSettings getAutoEncryptionSettings() {
         return autoEncryptionSettings;
     }
@@ -1653,10 +1658,14 @@ public Builder requiredReplicaSetName(final String requiredReplicaSetName) {
         /**
          * Set options for auto-encryption.
          *
+         * <p>
+         * Note: support for client side encryption is in beta.  Backwards-breaking changes may be made before the final release.
+         * </p>
          * @param autoEncryptionSettings auto encryption settings
          * @return this
          * @since 3.11
          */
+        @Beta
         public Builder autoEncryptionSettings(final AutoEncryptionSettings autoEncryptionSettings) {
             this.autoEncryptionSettings = autoEncryptionSettings;
             return this;

driver-sync/src/main/com/mongodb/client/vault/ClientEncryption.java

@@ -16,6 +16,7 @@
 
 package com.mongodb.client.vault;
 
+import com.mongodb.annotations.Beta;
 import com.mongodb.client.model.vault.DataKeyOptions;
 import com.mongodb.client.model.vault.EncryptOptions;
 import org.bson.BsonBinary;
@@ -28,8 +29,13 @@
  * <p>
  * Used to create data encryption keys, and to explicitly encrypt and decrypt values when auto-encryption is not an option.
  * </p>
+ * <p>
+ * Note: support for client-side encryption should be considered as beta.  Backwards-breaking changes may be made before the final
+ * release.
+ * </p>
  * @since 3.11
  */
+@Beta
 public interface ClientEncryption extends Closeable {
 
     /**

driver-sync/src/main/com/mongodb/client/vault/ClientEncryptions.java

@@ -17,13 +17,18 @@
 package com.mongodb.client.vault;
 
 import com.mongodb.ClientEncryptionSettings;
+import com.mongodb.annotations.Beta;
 import com.mongodb.client.internal.ClientEncryptionImpl;
 
 /**
  * Factory for ClientEncryption implementations.
  *
+ * <p>
+ * Note: support for client side encryption is in beta.  Backwards-breaking changes may be made before the final release.
+ * </p>
  * @since 3.11
  */
+@Beta
 public final class ClientEncryptions {
 
     /**