Interface Kv

All Known Implementing Classes:
KvMount, KvV1, KvV2

public interface Kv
Operations of a KV secrets engine mount (KvV1, KvV2 or the auto-detecting KvMount). Version-only operations raise UnsupportedException on KV v1. Paths are relative to the mount; each segment is percent-encoded.
  • Method Details

    • mount

      String mount()
      Returns the mount path.
      Returns:
      the mount, without slashes
    • read

      default KvSecret read(String path)
      Reads the latest version; NotFoundException when missing, deleted or destroyed.
      Parameters:
      path - secret path
      Returns:
      the secret
    • read

      default KvSecret read(String path, int version)
      Reads a specific version (KV v2).
      Parameters:
      path - secret path
      version - version number
      Returns:
      the secret
    • readAsync

      CompletableFuture<KvSecret> readAsync(String path, Integer version)
      Asynchronous read.
      Parameters:
      path - secret path
      version - version, or null for the latest
      Returns:
      a future with the secret
    • write

      default Optional<KvVersionMetadata> write(String path, Map<String,?> data)
      Writes (replaces) a secret.
      Parameters:
      path - secret path
      data - data map
      Returns:
      the new version metadata (empty on KV v1)
    • write

      default Optional<KvVersionMetadata> write(String path, Map<String,?> data, int cas)
      Writes with check-and-set (KV v2): fails with ConflictException unless the current version equals cas (0 = must not exist).
      Parameters:
      path - secret path
      data - data map
      cas - 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 path
      data - data map
      cas - expected current version, or null
      Returns:
      a future with the new version metadata
    • patch

      default KvVersionMetadata patch(String path, Map<String,?> data)
      Merges data into the latest version (KV v2, RFC 7386: a null value removes the key).
      Parameters:
      path - secret path
      data - fields to merge
      Returns:
      the new version metadata
    • patch

      default KvVersionMetadata patch(String path, Map<String,?> data, int cas)
      Patch with check-and-set (KV v2).
      Parameters:
      path - secret path
      data - fields to merge
      cas - expected current version
      Returns:
      the new version metadata
    • patchAsync

      CompletableFuture<KvVersionMetadata> patchAsync(String path, Map<String,?> data, Integer cas)
      Asynchronous patch.
      Parameters:
      path - secret path
      data - fields to merge
      cas - expected current version, or null
      Returns:
      a future with the new version metadata
    • delete

      default void delete(String path)
      Deletes a secret (KV v2: soft-deletes the latest version). Missing paths are no error.
      Parameters:
      path - secret path
    • deleteAsync

      CompletableFuture<Void> deleteAsync(String path)
      Asynchronous delete.
      Parameters:
      path - secret path
      Returns:
      a future completed when done
    • deleteVersions

      default void deleteVersions(String path, List<Integer> versions)
      Soft-deletes versions (KV v2).
      Parameters:
      path - secret path
      versions - positive version numbers
    • deleteVersionsAsync

      CompletableFuture<Void> deleteVersionsAsync(String path, List<Integer> versions)
      Asynchronous deleteVersions.
      Parameters:
      path - secret path
      versions - versions
      Returns:
      a future completed when done
    • undelete

      default void undelete(String path, List<Integer> versions)
      Restores soft-deleted versions (KV v2).
      Parameters:
      path - secret path
      versions - versions
    • undeleteAsync

      CompletableFuture<Void> undeleteAsync(String path, List<Integer> versions)
      Asynchronous undelete.
      Parameters:
      path - secret path
      versions - versions
      Returns:
      a future completed when done
    • destroy

      default void destroy(String path, List<Integer> versions)
      Permanently destroys versions (KV v2).
      Parameters:
      path - secret path
      versions - versions
    • destroyAsync

      CompletableFuture<Void> destroyAsync(String path, List<Integer> versions)
      Asynchronous destroy.
      Parameters:
      path - secret path
      versions - versions
      Returns:
      a future completed when done
    • list

      default List<String> list(String path)
      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

      CompletableFuture<List<String>> listAsync(String path)
      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

      default KvMetadata readMetadata(String path)
      Reads the metadata of a secret (KV v2); NotFoundException when missing.
      Parameters:
      path - secret path
      Returns:
      the metadata
    • readMetadataAsync

      CompletableFuture<KvMetadata> readMetadataAsync(String path)
      Asynchronous readMetadata.
      Parameters:
      path - secret path
      Returns:
      a future with the metadata
    • writeMetadata

      default void writeMetadata(String path, KvMetadataOptions options)
      Writes metadata settings of a secret (KV v2).
      Parameters:
      path - secret path
      options - settings
    • writeMetadataAsync

      CompletableFuture<Void> writeMetadataAsync(String path, KvMetadataOptions options)
      Asynchronous writeMetadata.
      Parameters:
      path - secret path
      options - settings
      Returns:
      a future completed when done
    • deleteMetadata

      default void deleteMetadata(String path)
      Deletes all versions and the metadata of a secret (KV v2). Missing paths are no error.
      Parameters:
      path - secret path
    • deleteMetadataAsync

      CompletableFuture<Void> deleteMetadataAsync(String path)
      Asynchronous deleteMetadata.
      Parameters:
      path - secret path
      Returns:
      a future completed when done