Package codes.grow.packages.vault
Class VaultSecretsProvider
java.lang.Object
codes.grow.packages.vault.secrets.BaseSecretsProvider
codes.grow.packages.vault.VaultSecretsProvider
- All Implemented Interfaces:
SecretsProvider,AutoCloseable
SecretsProvider over an Vault KV mount (v1 or v2, auto-detected):
client.secrets().
- One secret is one KV path (
<path>/<name>) whose data is{"value": "<string>"}; binary values are stored as base64 with"encoding": "base64"; objects are JSON-encoded. A path without avaluefield reads as the JSON of the whole map. - The KV v2 version is the
SecretValueversion (""on KV v1). deletesoft-deletes the latest version (KV v2),versionsdeletes those versions,permanentremoves every version and the metadata. Missing secrets raiseNotFoundException.list(prefix)lists one folder level (sub-folders skipped); on KV v2 every entry carries its metadata (read with up to 8 parallel calls) and secrets whose current version is deleted are skipped.
-
Field Summary
FieldsModifier and TypeFieldDescriptionCapabilities for the conformance runner.static final intParallel metadata reads inlist().Fields inherited from interface codes.grow.packages.vault.secrets.SecretsProvider
NUMBER -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Stops watchers and detaches from the client.protected Optional<SecretMetadata> fetchMetadata(String name, GetOptions opts) Reads metadata.protected Optional<SecretValue> fetchSecret(String name, GetOptions opts) Reads one secret.Returns the KV path of a secret:<path or provider path>/<name>.kv()Returns the KV mount.protected List<SecretMetadata> listSecrets(String prefixOrPath) Lists secrets under a prefix or folder (order does not matter; the base class sorts).protected StringputSecret(String name, byte[] value, SetOptions opts) Writes a secret.protected voidremoveSecret(String name, DeleteOptions opts) Deletes a secret.toString()Methods inherited from class codes.grow.packages.vault.secrets.BaseSecretsProvider
delete, ensureOpen, get, getAll, isClosed, list, metadata, set, toBytes, watchMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface codes.grow.packages.vault.secrets.SecretsProvider
asyncExecutor, delete, deleteAsync, exists, exists, existsAsync, get, getAllAsync, getAsync, getBool, getBool, getBoolAsync, getJson, getJson, getJson, getJsonAsync, getMany, getMany, getManyAsync, getNumber, getNumber, getNumberAsync, getString, getString, getStringAsync, list, listAsync, loadEnv, loadEnv, metadata, metadataAsync, require, require, requireAsync, set, setAsync, watch
-
Field Details
-
LIST_METADATA_CONCURRENCY
public static final int LIST_METADATA_CONCURRENCYParallel metadata reads inlist().- See Also:
-
CAPABILITIES
Capabilities for the conformance runner.
-
-
Method Details
-
kv
Returns the KV mount.- Returns:
- the mount
-
fullPath
Returns the KV path of a secret:<path or provider path>/<name>.- Parameters:
name- secret namepath- explicit base path, or null for the provider path- Returns:
- the KV path
-
fetchSecret
Description copied from class:BaseSecretsProviderReads one secret.- Specified by:
fetchSecretin classBaseSecretsProvider- Parameters:
name- full secret name (validated, non-empty)opts- version / path- Returns:
- the value, or empty when missing
-
listSecrets
Description copied from class:BaseSecretsProviderLists secrets under a prefix or folder (order does not matter; the base class sorts).- Specified by:
listSecretsin classBaseSecretsProvider- Parameters:
prefixOrPath- prefix or folder,""for the root- Returns:
- the metadata with full names
-
putSecret
Description copied from class:BaseSecretsProviderWrites a secret.- Specified by:
putSecretin classBaseSecretsProvider- Parameters:
name- full secret namevalue- bytes to storeopts- path / cas / tags / description- Returns:
- the new version, or
""
-
removeSecret
Description copied from class:BaseSecretsProviderDeletes a secret.- Specified by:
removeSecretin classBaseSecretsProvider- Parameters:
name- full secret nameopts- path / versions / permanent
-
fetchMetadata
Description copied from class:BaseSecretsProviderReads metadata.- Specified by:
fetchMetadatain classBaseSecretsProvider- Parameters:
name- full secret nameopts- version / path- Returns:
- the metadata, or empty when missing
-
close
public void close()Stops watchers and detaches from the client. Idempotent.- Specified by:
closein interfaceAutoCloseable- Overrides:
closein classBaseSecretsProvider
-
toString
-