DATAMONGO-2306 - Polishing.

Add Nullable annotation to nullable method args. Remove IV from JSON Schema as it is not listed in Mongo specs.

Tweak wording in docs.

Author: mp911de

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoEncryptionSettingsFactoryBean.java

@@ -20,6 +20,7 @@
 
 import org.bson.BsonDocument;
 import org.springframework.beans.factory.FactoryBean;
+import org.springframework.lang.Nullable;
 
 import com.mongodb.AutoEncryptionSettings;
 import com.mongodb.MongoClientSettings;
@@ -104,7 +105,7 @@ public AutoEncryptionSettings getObject() {
 				.build();
 	}
 
-	private <K, V> Map<K, V> orEmpty(Map<K, V> source) {
+	private <K, V> Map<K, V> orEmpty(@Nullable Map<K, V> source) {
 		return source != null ? source : Collections.emptyMap();
 	}
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/schema/IdentifiableJsonSchemaProperty.java

@@ -1057,26 +1057,23 @@ public static class EncryptedJsonSchemaProperty implements JsonSchemaProperty {
 
 		private final JsonSchemaProperty targetProperty;
 		private final @Nullable String algorithm;
-		private final @Nullable char[] keyId;
-		private final @Nullable char[] iv;
+		private final @Nullable String keyId;
 
 		/**
 		 * Create new instance of {@link EncryptedJsonSchemaProperty} wrapping the given {@link JsonSchemaProperty target}.
 		 *
 		 * @param target must not be {@literal null}.
 		 */
 		public EncryptedJsonSchemaProperty(JsonSchemaProperty target) {
-			this(target, null, null, null);
+			this(target, null, null);
 		}
 
-		private EncryptedJsonSchemaProperty(JsonSchemaProperty target, @Nullable String algorithm, @Nullable char[] keyId,
-				@Nullable char[] iv) {
+		private EncryptedJsonSchemaProperty(JsonSchemaProperty target, @Nullable String algorithm, @Nullable String keyId) {
 
 			Assert.notNull(target, "Target must not be null!");
 			this.targetProperty = target;
 			this.algorithm = algorithm;
 			this.keyId = keyId;
-			this.iv = iv;
 		}
 
 		/**
@@ -1113,19 +1110,15 @@ public EncryptedJsonSchemaProperty aead_aes_256_cbc_hmac_sha_512_deterministic()
 		 * @return new instance of {@link EncryptedJsonSchemaProperty}.
 		 */
 		public EncryptedJsonSchemaProperty algorithm(String algorithm) {
-			return new EncryptedJsonSchemaProperty(targetProperty, algorithm, keyId, iv);
+			return new EncryptedJsonSchemaProperty(targetProperty, algorithm, keyId);
 		}
 
 		/**
 		 * @param key
 		 * @return
 		 */
-		public EncryptedJsonSchemaProperty keyId(char[] key) {
-			return new EncryptedJsonSchemaProperty(targetProperty, algorithm, key, iv);
-		}
-
-		public EncryptedJsonSchemaProperty keyId(String key) {
-			return keyId(key.toCharArray());
+		public EncryptedJsonSchemaProperty keyId(String keyId) {
+			return new EncryptedJsonSchemaProperty(targetProperty, algorithm, keyId);
 		}
 
 		/*
@@ -1141,7 +1134,7 @@ public Document toDocument() {
 			Document enc = new Document();
 
 			if (!ObjectUtils.isEmpty(keyId)) {
-				enc.append("keyId", new String(keyId));
+				enc.append("keyId", keyId);
 			}
 
 			Type type = extractPropertyType(propertySpecification);

src/main/asciidoc/reference/mongo-json-schema.adoc

@@ -208,7 +208,7 @@ template.find(query(matchingDocumentStructure(schema)), Person.class);
 [[mongo.jsonSchema.encrypted-fields]]
 ==== Encrypted Fields
 
-MongoDB 4.2 https://docs.mongodb.com/master/core/security-client-side-encryption/[Field Level Encryption] allows to directly secure certain properties.
+MongoDB 4.2 https://docs.mongodb.com/master/core/security-client-side-encryption/[Field Level Encryption] allows to directly encrypt individual properties.
 
 Properties can be wrapped within an encrypted property when setting up the JSON Schema as shown in the example below.
 
@@ -225,7 +225,7 @@ MongoJsonSchema schema = MongoJsonSchema.builder()
 ----
 ====
 
-NOTE: Make sure to set the drivers `com.mongodb.AutoEncryptionSettings` to use client side encryption.
+NOTE: Make sure to set the drivers `com.mongodb.AutoEncryptionSettings` to use client-side encryption.
 
 [[mongo.jsonSchema.types]]
 ==== JSON Schema Types