diff --git a/pom.xml b/pom.xml index a56ab7c5..4974d22f 100644 --- a/pom.xml +++ b/pom.xml @@ -1,5 +1,7 @@ - + 4.0.0 org.springframework.vault @@ -39,7 +41,7 @@ ${project.build.directory}/doc-resources - + 2016 @@ -416,6 +418,9 @@ true none + + https://docs.spring.io/spring/docs/current/javadoc-api + https://docs.spring.io/spring-data/commons/docs/current/api diff --git a/spring-vault-core/src/main/java/org/springframework/vault/authentication/AppRoleAuthenticationOptions.java b/spring-vault-core/src/main/java/org/springframework/vault/authentication/AppRoleAuthenticationOptions.java index fa5bea7d..262c15d1 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/authentication/AppRoleAuthenticationOptions.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/authentication/AppRoleAuthenticationOptions.java @@ -209,7 +209,7 @@ public class AppRoleAuthenticationOptions { * * @param roleId must not be empty or {@literal null}. * @return {@code this} {@link AppRoleAuthenticationOptionsBuilder}. - * @deprecated since 2.0, use {@link #roleId(RoleId)}. + * @deprecated since 2.0, use {@link #roleId(AppRoleAuthenticationOptions.RoleId)}. */ @Deprecated public AppRoleAuthenticationOptionsBuilder roleId(String roleId) { @@ -240,7 +240,7 @@ public class AppRoleAuthenticationOptions { * * @param secretId must not be empty or {@literal null}. * @return {@code this} {@link AppRoleAuthenticationOptionsBuilder}. - * @deprecated since 2.0, use {@link #secretId(SecretId)}. + * @deprecated since 2.0, use {@link #secretId(AppRoleAuthenticationOptions.SecretId)}. */ @Deprecated public AppRoleAuthenticationOptionsBuilder secretId(String secretId) { @@ -288,7 +288,8 @@ public class AppRoleAuthenticationOptions { * @param initialToken must not be empty or {@literal null}. * @return {@code this} {@link AppRoleAuthenticationOptionsBuilder}. * @since 1.1 - * @deprecated since 2.0, use {@link #roleId(RoleId)}/{@link #secretId(SecretId)} + * @deprecated since 2.0, use + * {@link #roleId(AppRoleAuthenticationOptions.RoleId)}/{@link #secretId(AppRoleAuthenticationOptions.SecretId)} * to configure pull mode. */ @Deprecated diff --git a/spring-vault-core/src/main/java/org/springframework/vault/client/VaultResponses.java b/spring-vault-core/src/main/java/org/springframework/vault/client/VaultResponses.java index 8164729b..857903a5 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/client/VaultResponses.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/client/VaultResponses.java @@ -142,7 +142,7 @@ public abstract class VaultResponses { * Obtain the error message from a JSON response. * * @param json must not be {@literal null}. - * @return + * @return extracted error string. */ @SuppressWarnings("unchecked") public static String getError(String json) { diff --git a/spring-vault-core/src/main/java/org/springframework/vault/core/VaultKeyValueOperations.java b/spring-vault-core/src/main/java/org/springframework/vault/core/VaultKeyValueOperations.java index 4bda2e15..d849c7c8 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/core/VaultKeyValueOperations.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/core/VaultKeyValueOperations.java @@ -31,7 +31,7 @@ import org.springframework.vault.support.VaultResponseSupport; * @author Mark Paluch * @since 2.1 * @see VaultVersionedKeyValueOperations - * @see KeyValueBackend + * @see VaultKeyValueOperationsSupport.KeyValueBackend */ public interface VaultKeyValueOperations extends VaultKeyValueOperationsSupport { @@ -59,7 +59,6 @@ public interface VaultKeyValueOperations extends VaultKeyValueOperationsSupport * * @param path must not be {@literal null}. * @param body must not be {@literal null}. - * @return the resulting {@link VaultResponse}. */ void put(String path, Object body); } diff --git a/spring-vault-core/src/main/java/org/springframework/vault/core/env/VaultPropertySourceNotFoundException.java b/spring-vault-core/src/main/java/org/springframework/vault/core/env/VaultPropertySourceNotFoundException.java index 2b4e83d2..125ccb0a 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/core/env/VaultPropertySourceNotFoundException.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/core/env/VaultPropertySourceNotFoundException.java @@ -23,7 +23,7 @@ import org.springframework.vault.annotation.VaultPropertySource; * * @author Mark Paluch * @since 2.2 - * @see VaultPropertySource#ignoreSecretNotFound() + * @see VaultPropertySource#ignoreSecretNotFound */ public class VaultPropertySourceNotFoundException extends VaultException { diff --git a/spring-vault-core/src/main/java/org/springframework/vault/repository/convert/MappingVaultConverter.java b/spring-vault-core/src/main/java/org/springframework/vault/repository/convert/MappingVaultConverter.java index f079c5e0..9254e109 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/repository/convert/MappingVaultConverter.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/repository/convert/MappingVaultConverter.java @@ -308,9 +308,8 @@ public class MappingVaultConverter extends AbstractVaultConverter { * @param type the {@link Map} {@link TypeInformation} to be used to unmarshal this * {@link Map}. * @param sourceMap must not be {@literal null} - * @return + * @return the converted {@link Map}. */ - @SuppressWarnings("unchecked") protected Map readMap(TypeInformation type, Map sourceMap) { @@ -539,7 +538,7 @@ public class MappingVaultConverter extends AbstractVaultConverter { * * @param collection must not be {@literal null}. * @param property must not be {@literal null}. - * @return + * @return the converted {@link List}. */ protected List createCollection(Collection collection, VaultPersistentProperty property) { @@ -555,7 +554,7 @@ public class MappingVaultConverter extends AbstractVaultConverter { * {@literal null}. * @param type the {@link TypeInformation} to consider or {@literal null} if unknown. * @param sink the {@link List} to write to. - * @return + * @return the converted {@link List}. */ private List writeCollectionInternal(Collection source, @Nullable TypeInformation type, List sink) { @@ -594,7 +593,7 @@ public class MappingVaultConverter extends AbstractVaultConverter { * * @param map must not {@literal null}. * @param property must not be {@literal null}. - * @return + * @return the converted {@link Map}. */ protected Map createMap(Map map, VaultPersistentProperty property) { @@ -613,7 +612,7 @@ public class MappingVaultConverter extends AbstractVaultConverter { * @param obj must not be {@literal null}. * @param bson must not be {@literal null}. * @param propertyType must not be {@literal null}. - * @return + * @return the converted {@link Map}. */ protected Map writeMapInternal(Map obj, Map bson, TypeInformation propertyType) { @@ -657,7 +656,7 @@ public class MappingVaultConverter extends AbstractVaultConverter { * is if the value is not the same as the one given. This is usually the case if you * store a subtype of the actual declared type of the property. * - * @param type + * @param type type hint. * @param value must not be {@literal null}. * @param accessor must not be {@literal null}. */ @@ -678,8 +677,8 @@ public class MappingVaultConverter extends AbstractVaultConverter { * arbitrary simple Vault type. Returns the converted value if so. If not, we perform * special enum handling or simply return the value as is. * - * @param value - * @return + * @param value the value to write. + * @return the converted value. Can be {@literal null}. */ @Nullable private Object getPotentiallyConvertedSimpleWrite(@Nullable Object value) { @@ -713,8 +712,9 @@ public class MappingVaultConverter extends AbstractVaultConverter { * {@link Collection} or simply create a single element collection for everything * else. * - * @param source - * @return + * @param source the collection object. Can be a {@link Collection}, array or + * singleton object. + * @return the {@code source} as {@link Collection}. */ private static Collection asCollection(Object source) { diff --git a/spring-vault-core/src/main/java/org/springframework/vault/security/VaultBytesKeyGenerator.java b/spring-vault-core/src/main/java/org/springframework/vault/security/VaultBytesKeyGenerator.java index 5de0cc2f..fdd1ebb0 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/security/VaultBytesKeyGenerator.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/security/VaultBytesKeyGenerator.java @@ -42,7 +42,7 @@ public class VaultBytesKeyGenerator implements BytesKeyGenerator { private String transitPath; /** - * Creates a new {@link VaultBytesKeyGenerator} initialized to generate {@link 32} + * Creates a new {@link VaultBytesKeyGenerator} initialized to generate {@code 32} * random bytes using {@code transit} for transit mount path. * * @param vaultOperations must not be {@literal null}. diff --git a/spring-vault-core/src/main/java/org/springframework/vault/support/LeaseStrategy.java b/spring-vault-core/src/main/java/org/springframework/vault/support/LeaseStrategy.java index 7e042c50..806dc8f7 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/support/LeaseStrategy.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/support/LeaseStrategy.java @@ -38,7 +38,7 @@ public interface LeaseStrategy { /** * Predefined strategy to drop leases on error. * - * @return + * @return the drop on error strategy. */ static LeaseStrategy dropOnError() { return error -> true; @@ -47,7 +47,7 @@ public interface LeaseStrategy { /** * Predefined strategy to retain leases on error. * - * @return + * @return the retain on error strategy. */ static LeaseStrategy retainOnError() { return error -> false; diff --git a/spring-vault-core/src/main/java/org/springframework/vault/support/Policy.java b/spring-vault-core/src/main/java/org/springframework/vault/support/Policy.java index e5222f87..8eaa3c36 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/support/Policy.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/support/Policy.java @@ -485,7 +485,7 @@ public class Policy { /** * Build the {@link Rule} object. Requires a configured {@link #path(String)} - * and at least one {@link #capability(Capability)}. + * and at least one {@link #capability(Policy.Capability)}. * * @return the new {@link Rule} object. */ diff --git a/spring-vault-core/src/main/java/org/springframework/vault/support/VaultSignatureVerificationRequest.java b/spring-vault-core/src/main/java/org/springframework/vault/support/VaultSignatureVerificationRequest.java index b458508b..f1c05621 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/support/VaultSignatureVerificationRequest.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/support/VaultSignatureVerificationRequest.java @@ -144,7 +144,7 @@ public class VaultSignatureVerificationRequest { /** * Configure the {@link Signature} to be verified. Signature verification requires * either a {@link Signature} or a {@link #hmac(Hmac)} to be configured. Clears - * any previously configured {@link HMAC}. + * any previously configured {@link #hmac(Hmac)}. * * @param signature to be verified, must not be {@literal null}. * @return {@code this} {@link VaultSignatureVerificationRequestBuilder}. diff --git a/spring-vault-core/src/main/java/org/springframework/vault/support/Versioned.java b/spring-vault-core/src/main/java/org/springframework/vault/support/Versioned.java index 7952e3e9..d9da24f9 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/support/Versioned.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/support/Versioned.java @@ -373,10 +373,10 @@ public class Versioned { } /** - * Build the {@link Metadata} object. Requires {@link #createdAt(Instant)} and - * {@link #version(Version)} to be set. + * Build the {@link Versioned.Metadata} object. Requires {@link #createdAt(Instant)} and + * {@link #version(Versioned.Version)} to be set. * - * @return the {@link Metadata} object. + * @return the {@link Versioned.Metadata} object. */ public Metadata build() { diff --git a/spring-vault-dependencies/pom.xml b/spring-vault-dependencies/pom.xml index 8111d7dd..8aad243e 100644 --- a/spring-vault-dependencies/pom.xml +++ b/spring-vault-dependencies/pom.xml @@ -168,7 +168,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.0.1 + 3.1.1