Polishing.

Add author and since tags. Refine nullability and toString rendering.

Original pull request: gh-808
See gh-789

Author: mp911de

spring-vault-core/src/main/java/org/springframework/vault/core/VaultKeyValueMetadataTemplate.java

@@ -36,6 +36,7 @@
  *
  * @author Zakaria Amine
  * @author Mark Paluch
+ * @author Jeroen Willemsen
  * @since 2.3
  */
 class VaultKeyValueMetadataTemplate implements VaultKeyValueMetadataOperations {
@@ -120,12 +121,8 @@ private static Versioned.Metadata buildVersion(String version, Map<String, Objec
 			.createdAt(createdTime)
 			.deletedAt(deletionTime)
 			.destroyed(destroyed)
-			.version(kvVersion);
-
-		if (versionData.get("custom_metadata") != null) {
-			Map<String, String> customMetadata = (Map<String, String>) versionData.get("custom_metadata");
-			builder.customMetadata(customMetadata);
-		}
+			.version(kvVersion)
+			.customMetadata((Map<String, String>) versionData.get("custom_metadata"));
 
 		return builder.build();
 	}

spring-vault-core/src/main/java/org/springframework/vault/core/VaultVersionedKeyValueOperations.java

@@ -43,6 +43,7 @@ public interface VaultVersionedKeyValueOperations extends VaultKeyValueOperation
 	 * @param path must not be {@literal null}.
 	 * @return the data. May be {@literal null} if the path does not exist.
 	 */
+	@Override
 	@Nullable
 	default Versioned<Map<String, Object>> get(String path) {
 		return get(path, Version.unversioned());

spring-vault-core/src/main/java/org/springframework/vault/core/VaultVersionedKeyValueTemplate.java

@@ -46,6 +46,7 @@
  *
  * @author Mark Paluch
  * @author Maciej Drozdzowski
+ * @author Jeroen Willemsen
  * @since 2.1
  */
 public class VaultVersionedKeyValueTemplate extends VaultKeyValue2Accessor implements VaultVersionedKeyValueOperations {
@@ -159,6 +160,7 @@ public Metadata put(String path, Object body) {
 		return getMetadata(response.getRequiredData());
 	}
 
+	@SuppressWarnings("unchecked")
 	private static Metadata getMetadata(Map<String, Object> responseMetadata) {
 
 		MetadataBuilder builder = Metadata.builder();
@@ -176,12 +178,8 @@ private static Metadata getMetadata(Map<String, Object> responseMetadata) {
 		}
 
 		Integer version = (Integer) responseMetadata.get("version");
-		builder.version(Version.from(version));
-
-		if (responseMetadata.get("custom_metadata") != null) {
-			Map<String, String> customMetadata = (Map<String, String>) responseMetadata.get("custom_metadata");
-			builder.customMetadata(customMetadata);
-		}
+		builder.version(Version.from(version))
+			.customMetadata((Map<String, String>) responseMetadata.get("custom_metadata"));
 
 		return builder.build();
 	}

spring-vault-core/src/main/java/org/springframework/vault/support/VaultMetadataRequest.java

@@ -26,6 +26,7 @@
  * Value object to bind Vault HTTP kv metadata update API requests.
  *
  * @author Zakaria Amine
+ * @author Jeroen Willemsen
  * @see <a href=
  * "https://www.vaultproject.io/api-docs/secret/kv/kv-v2#update-metadata">Update
  * Metadata</a>
@@ -43,28 +44,21 @@ public class VaultMetadataRequest {
 	private final String deleteVersionAfter;
 
 	@JsonProperty("custom_metadata")
-	private final Map<String, String> customMetadata;
+	private final @Nullable Map<String, String> customMetadata;
 
-	private VaultMetadataRequest(int maxVersions, boolean casRequired, @Nullable Duration deleteVersionAfter,
-			@Nullable Map<String, String> customMetadata) {
-		this.maxVersions = maxVersions;
+	private VaultMetadataRequest(boolean casRequired, @Nullable Map<String, String> customMetadata,
+			@Nullable Duration deleteVersionAfter, int maxVersions) {
 		this.casRequired = casRequired;
+		this.customMetadata = customMetadata;
 		this.deleteVersionAfter = DurationParser
 			.formatDuration(deleteVersionAfter != null ? deleteVersionAfter : Duration.ZERO);
-		this.customMetadata = customMetadata;
+		this.maxVersions = maxVersions;
 	}
 
 	public static VaultMetadataRequestBuilder builder() {
 		return new VaultMetadataRequestBuilder();
 	}
 
-	/**
-	 * @return The number of versions to keep per key.
-	 */
-	public int getMaxVersions() {
-		return this.maxVersions;
-	}
-
 	/**
 	 * @return If true all keys will require the cas parameter to be set on all write
 	 * requests.
@@ -73,6 +67,11 @@ public boolean isCasRequired() {
 		return this.casRequired;
 	}
 
+	@Nullable
+	public Map<String, String> getCustomMetadata() {
+		return this.customMetadata;
+	}
+
 	/**
 	 * @return the deletion_time for all new versions written to this key. Accepts
 	 * <a href="https://golang.org/pkg/time/#ParseDuration">Go duration format string</a>.
@@ -81,31 +80,33 @@ public String getDeleteVersionAfter() {
 		return this.deleteVersionAfter;
 	}
 
-	@Nullable
-	public Map<String, String> getCustomMetadata() {
-		return this.customMetadata;
+	/**
+	 * @return The number of versions to keep per key.
+	 */
+	public int getMaxVersions() {
+		return this.maxVersions;
 	}
 
 	public static class VaultMetadataRequestBuilder {
 
-		private int maxVersions;
-
 		private boolean casRequired;
 
 		@Nullable
-		private Duration deleteVersionAfter;
+		private Map<String, String> customMetadata;
 
 		@Nullable
-		private Map<String, String> customMetadata;
+		private Duration deleteVersionAfter;
+
+		private int maxVersions;
 
 		/**
-		 * Set the number of versions to keep per key.
-		 * @param maxVersions
+		 * Set the cas_required parameter to {@code true} to require the cas parameter to
+		 * be set on all write requests.
 		 * @return {@link VaultMetadataRequest}
+		 * @since 3.1
 		 */
-		public VaultMetadataRequestBuilder maxVersions(int maxVersions) {
-			this.maxVersions = maxVersions;
-			return this;
+		public VaultMetadataRequestBuilder casRequired() {
+			return casRequired(true);
 		}
 
 		/**
@@ -119,6 +120,17 @@ public VaultMetadataRequestBuilder casRequired(boolean casRequired) {
 			return this;
 		}
 
+		/**
+		 * Sets the custom Metadata for the metadata request.
+		 * @param customMetadata
+		 * @return {@link VaultMetadataRequest}
+		 * @since 3.1
+		 */
+		public VaultMetadataRequestBuilder customMetadata(Map<String, String> customMetadata) {
+			this.customMetadata = customMetadata;
+			return this;
+		}
+
 		/**
 		 * Sets the deletion time for all new versions written to this key.
 		 * @param deleteVersionAfter
@@ -130,21 +142,21 @@ public VaultMetadataRequestBuilder deleteVersionAfter(Duration deleteVersionAfte
 		}
 
 		/**
-		 * Sets the custom Metadata for the metadatarequest
-		 * @param customMetadata
+		 * Set the number of versions to keep per key.
+		 * @param maxVersions
 		 * @return {@link VaultMetadataRequest}
 		 */
-		public VaultMetadataRequestBuilder customMetadata(Map<String, String> customMetadata) {
-			this.customMetadata = customMetadata;
+		public VaultMetadataRequestBuilder maxVersions(int maxVersions) {
+			this.maxVersions = maxVersions;
 			return this;
 		}
 
 		/**
 		 * @return a new {@link VaultMetadataRequest}
 		 */
 		public VaultMetadataRequest build() {
-			return new VaultMetadataRequest(this.maxVersions, this.casRequired, this.deleteVersionAfter,
-					this.customMetadata);
+			return new VaultMetadataRequest(this.casRequired, this.customMetadata, this.deleteVersionAfter,
+					this.maxVersions);
 		}
 
 	}

spring-vault-core/src/main/java/org/springframework/vault/support/VaultMetadataResponse.java

@@ -18,15 +18,18 @@
 import java.time.Duration;
 import java.time.Instant;
 import java.time.Period;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
 import org.springframework.lang.Nullable;
+import org.springframework.vault.support.Versioned.Metadata;
 
 /**
  * Value object to bind Vault HTTP kv read metadata API responses.
  *
  * @author Zakaria Amine
+ * @author Jeroen Willemsen
  * @since 2.3
  */
 public class VaultMetadataResponse {
@@ -37,6 +40,8 @@ public class VaultMetadataResponse {
 
 	private final int currentVersion;
 
+	private final Map<String, String> customMetadata;
+
 	private final Duration deleteVersionAfter;
 
 	private final int maxVersions;
@@ -47,20 +52,19 @@ public class VaultMetadataResponse {
 
 	private final List<Versioned.Metadata> versions;
 
-	private final Map<String, String> customMetadata;
-
 	private VaultMetadataResponse(boolean casRequired, Instant createdTime, int currentVersion,
-			Duration deleteVersionAfter, int maxVersions, int oldestVersion, Instant updatedTime,
-			List<Versioned.Metadata> versions, Map<String, String> customMetadata) {
+			Map<String, String> customMetadata, Duration deleteVersionAfter, int maxVersions, int oldestVersion,
+			Instant updatedTime, List<Metadata> versions) {
+
 		this.casRequired = casRequired;
 		this.createdTime = createdTime;
+		this.customMetadata = customMetadata;
 		this.currentVersion = currentVersion;
 		this.deleteVersionAfter = deleteVersionAfter;
 		this.maxVersions = maxVersions;
 		this.oldestVersion = oldestVersion;
 		this.updatedTime = updatedTime;
 		this.versions = versions;
-		this.customMetadata = customMetadata;
 	}
 
 	public static VaultMetadataResponseBuilder builder() {
@@ -98,9 +102,9 @@ public Duration getDeleteVersionAfter() {
 	}
 
 	/**
-	 * @return KV of customMetadata. Entries can be any arbitrary key-value pairs
+	 * @return the custom metadata. Entries can be any arbitrary key-value pairs
+	 * @since 3.1
 	 */
-	@Nullable
 	public Map<String, String> getCustomMetadata() {
 		return this.customMetadata;
 	}
@@ -127,12 +131,10 @@ public Instant getUpdatedTime() {
 	}
 
 	/**
-	 * Follows the following format.
-	 *
-	 * "versions": { "1": { "created_time": "2020-05-18T12:23:09.895587932Z",
-	 * "deletion_time": "2020-05-18T12:31:00.66257744Z", "destroyed": false }, "2": {
-	 * "created_time": "2020-05-18T12:23:10.122081788Z", "deletion_time": "", "destroyed":
-	 * false } }
+	 * Follows the following format. "versions": { "1": { "created_time":
+	 * "2020-05-18T12:23:09.895587932Z", "deletion_time": "2020-05-18T12:31:00.66257744Z",
+	 * "destroyed": false }, "2": { "created_time": "2020-05-18T12:23:10.122081788Z",
+	 * "deletion_time": "", "destroyed": false } }
 	 * @return the key versions and their details
 	 */
 	public List<Versioned.Metadata> getVersions() {
@@ -143,6 +145,8 @@ public static class VaultMetadataResponseBuilder {
 
 		private boolean casRequired;
 
+		private Map<String, String> customMetadata;
+
 		private Instant createdTime;
 
 		private int currentVersion;
@@ -157,8 +161,6 @@ public static class VaultMetadataResponseBuilder {
 
 		private List<Versioned.Metadata> versions;
 
-		private Map<String, String> customMetadata;
-
 		public VaultMetadataResponseBuilder casRequired(boolean casRequired) {
 			this.casRequired = casRequired;
 			return this;
@@ -174,6 +176,11 @@ public VaultMetadataResponseBuilder currentVersion(int currentVersion) {
 			return this;
 		}
 
+		public VaultMetadataResponseBuilder customMetadata(@Nullable Map<String, String> customMetadata) {
+			this.customMetadata = customMetadata != null ? customMetadata : Collections.emptyMap();
+			return this;
+		}
+
 		public VaultMetadataResponseBuilder deleteVersionAfter(Duration deleteVersionAfter) {
 			this.deleteVersionAfter = deleteVersionAfter;
 			return this;
@@ -199,15 +206,10 @@ public VaultMetadataResponseBuilder versions(List<Versioned.Metadata> versions)
 			return this;
 		}
 
-		public VaultMetadataResponseBuilder customMetadata(Map<String, String> customMetadata) {
-			this.customMetadata = customMetadata;
-			return this;
-		}
-
 		public VaultMetadataResponse build() {
 			return new VaultMetadataResponse(this.casRequired, this.createdTime, this.currentVersion,
-					this.deleteVersionAfter, this.maxVersions, this.oldestVersion, this.updatedTime, this.versions,
-					this.customMetadata);
+					this.customMetadata, this.deleteVersionAfter, this.maxVersions, this.oldestVersion,
+					this.updatedTime, this.versions);
 		}
 
 	}