From e578591a497e70356fb05d25f9ff7a9c0f07c3fa Mon Sep 17 00:00:00 2001 From: Stefan Kalscheuer Date: Fri, 11 Jun 2021 21:33:59 +0200 Subject: [PATCH] deprecate convenience methods to interact with "secret/" mount (#52) --- CHANGELOG.md | 5 +++-- .../java/de/stklcode/jvault/connector/VaultConnector.java | 8 ++++++++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 029cf95..c56b769 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,9 @@ ## 0.9.5 (unreleased) ### Deprecations -* Deprecated builder invocation `VaultConnectorBuilder.http()` in favor of `HTTPVaultConnector.builder()`. -* Deprecated `de.stklcode.jvault.connector.builder.HTTPVaultConnectorBuilder` in favor of `de.stklcode.jvault.connector.HTTPVaultConnectorBuilder` (only package changed). +* Deprecate ` {read,write,delete}Secret()` convenience methods. Use `{read,write,delete}("secret/...")` instead (#52) +* Deprecated builder invocation `VaultConnectorBuilder.http()` in favor of `HTTPVaultConnector.builder()` (#51) +* Deprecated `de.stklcode.jvault.connector.builder.HTTPVaultConnectorBuilder` in favor of `de.stklcode.jvault.connector.HTTPVaultConnectorBuilder` (only package changed) (#51) Old builders will be removed in 1.0 diff --git a/src/main/java/de/stklcode/jvault/connector/VaultConnector.java b/src/main/java/de/stklcode/jvault/connector/VaultConnector.java index 4fc1a0f..cf3732c 100644 --- a/src/main/java/de/stklcode/jvault/connector/VaultConnector.java +++ b/src/main/java/de/stklcode/jvault/connector/VaultConnector.java @@ -401,7 +401,9 @@ public interface VaultConnector extends AutoCloseable, Serializable { * @param key Secret identifier * @return Secret response * @throws VaultConnectorException on error + * @deprecated Convenience method will be removed in 1.0. Use {@link #read(String)} instead with key prefix "secret/". */ + @Deprecated default SecretResponse readSecret(final String key) throws VaultConnectorException { return read(PATH_SECRET + "/" + key); } @@ -642,7 +644,9 @@ public interface VaultConnector extends AutoCloseable, Serializable { * @param key Secret path * @param value Secret value * @throws VaultConnectorException on error + * @deprecated Convenience method will be removed in 1.0. Use {@link #write(String, String)} instead with key prefix "secret/". */ + @Deprecated default void writeSecret(final String key, final String value) throws VaultConnectorException { writeSecret(key, Collections.singletonMap("value", value)); } @@ -656,7 +660,9 @@ public interface VaultConnector extends AutoCloseable, Serializable { * @param data Secret content. Value must be be JSON serializable. * @throws VaultConnectorException on error * @since 0.5.0 + * @deprecated Convenience method will be removed in 1.0. Use {@link #write(String, Map)} instead with key prefix "secret/". */ + @Deprecated default void writeSecret(final String key, final Map data) throws VaultConnectorException { if (key == null || key.isEmpty()) { throw new InvalidRequestException("Secret path must not be empty."); @@ -680,7 +686,9 @@ public interface VaultConnector extends AutoCloseable, Serializable { * * @param key Secret path * @throws VaultConnectorException on error + * @deprecated Convenience method will be removed in 1.0. Use {@link #delete(String)} instead with key prefix "secret/". */ + @Deprecated default void deleteSecret(final String key) throws VaultConnectorException { delete(PATH_SECRET + "/" + key); }