Package codes.grow.packages.vault
Interface Kv
public interface Kv
-
Method Summary
Modifier and TypeMethodDescriptiondefault voidDeletes a secret (KV v2: soft-deletes the latest version).deleteAsync(String path) Asynchronous delete.default voiddeleteMetadata(String path) Deletes all versions and the metadata of a secret (KV v2).deleteMetadataAsync(String path) Asynchronous deleteMetadata.default voiddeleteVersions(String path, List<Integer> versions) Soft-deletes versions (KV v2).deleteVersionsAsync(String path, List<Integer> versions) Asynchronous deleteVersions.default voidPermanently destroys versions (KV v2).destroyAsync(String path, List<Integer> versions) Asynchronous destroy.Lists the keys of a folder (sorted; sub-folders end in/); empty when missing.Asynchronous list.mount()Returns the mount path.default KvVersionMetadataMergesdatainto the latest version (KV v2, RFC 7386: a null value removes the key).default KvVersionMetadataPatch with check-and-set (KV v2).patchAsync(String path, Map<String, ?> data, Integer cas) Asynchronous patch.default KvSecretReads the latest version;NotFoundExceptionwhen missing, deleted or destroyed.default KvSecretReads a specific version (KV v2).Asynchronous read.default KvMetadatareadMetadata(String path) Reads the metadata of a secret (KV v2);NotFoundExceptionwhen missing.readMetadataAsync(String path) Asynchronous readMetadata.default voidRestores soft-deleted versions (KV v2).undeleteAsync(String path, List<Integer> versions) Asynchronous undelete.default Optional<KvVersionMetadata> Writes (replaces) a secret.default Optional<KvVersionMetadata> Writes with check-and-set (KV v2): fails withConflictExceptionunless the current version equalscas(0 = must not exist).writeAsync(String path, Map<String, ?> data, Integer cas) Asynchronous write.default voidwriteMetadata(String path, KvMetadataOptions options) Writes metadata settings of a secret (KV v2).writeMetadataAsync(String path, KvMetadataOptions options) Asynchronous writeMetadata.
-
Method Details
-
mount
String mount()Returns the mount path.- Returns:
- the mount, without slashes
-
read
Reads the latest version;NotFoundExceptionwhen missing, deleted or destroyed.- Parameters:
path- secret path- Returns:
- the secret
-
read
Reads a specific version (KV v2).- Parameters:
path- secret pathversion- version number- Returns:
- the secret
-
readAsync
Asynchronous read.- Parameters:
path- secret pathversion- version, or null for the latest- Returns:
- a future with the secret
-
write
Writes (replaces) a secret.- Parameters:
path- secret pathdata- data map- Returns:
- the new version metadata (empty on KV v1)
-
write
Writes with check-and-set (KV v2): fails withConflictExceptionunless the current version equalscas(0 = must not exist).- Parameters:
path- secret pathdata- data mapcas- expected current version- Returns:
- the new version metadata
-
writeAsync
CompletableFuture<Optional<KvVersionMetadata>> writeAsync(String path, Map<String, ?> data, Integer cas) Asynchronous write.- Parameters:
path- secret pathdata- data mapcas- expected current version, or null- Returns:
- a future with the new version metadata
-
patch
Mergesdatainto the latest version (KV v2, RFC 7386: a null value removes the key).- Parameters:
path- secret pathdata- fields to merge- Returns:
- the new version metadata
-
patch
Patch with check-and-set (KV v2).- Parameters:
path- secret pathdata- fields to mergecas- expected current version- Returns:
- the new version metadata
-
patchAsync
Asynchronous patch.- Parameters:
path- secret pathdata- fields to mergecas- expected current version, or null- Returns:
- a future with the new version metadata
-
delete
Deletes a secret (KV v2: soft-deletes the latest version). Missing paths are no error.- Parameters:
path- secret path
-
deleteAsync
Asynchronous delete.- Parameters:
path- secret path- Returns:
- a future completed when done
-
deleteVersions
Soft-deletes versions (KV v2).- Parameters:
path- secret pathversions- positive version numbers
-
deleteVersionsAsync
Asynchronous deleteVersions.- Parameters:
path- secret pathversions- versions- Returns:
- a future completed when done
-
undelete
Restores soft-deleted versions (KV v2).- Parameters:
path- secret pathversions- versions
-
undeleteAsync
Asynchronous undelete.- Parameters:
path- secret pathversions- versions- Returns:
- a future completed when done
-
destroy
Permanently destroys versions (KV v2).- Parameters:
path- secret pathversions- versions
-
destroyAsync
Asynchronous destroy.- Parameters:
path- secret pathversions- versions- Returns:
- a future completed when done
-
list
Lists the keys of a folder (sorted; sub-folders end in/); empty when missing.- Parameters:
path- folder path,""for the mount root- Returns:
- the keys
-
listAsync
Asynchronous list. Vault OSS lists have no pagination: every key is returned at once.- Parameters:
path- folder path- Returns:
- a future with the keys
-
readMetadata
Reads the metadata of a secret (KV v2);NotFoundExceptionwhen missing.- Parameters:
path- secret path- Returns:
- the metadata
-
readMetadataAsync
Asynchronous readMetadata.- Parameters:
path- secret path- Returns:
- a future with the metadata
-
writeMetadata
Writes metadata settings of a secret (KV v2).- Parameters:
path- secret pathoptions- settings
-
writeMetadataAsync
Asynchronous writeMetadata.- Parameters:
path- secret pathoptions- settings- Returns:
- a future completed when done
-
deleteMetadata
Deletes all versions and the metadata of a secret (KV v2). Missing paths are no error.- Parameters:
path- secret path
-
deleteMetadataAsync
Asynchronous deleteMetadata.- Parameters:
path- secret path- Returns:
- a future completed when done
-