Class BaseSecretsProvider

java.lang.Object
codes.grow.packages.vault.secrets.BaseSecretsProvider
All Implemented Interfaces:
SecretsProvider, AutoCloseable
Direct Known Subclasses:
InMemorySecretsProvider, VaultSecretsProvider

public abstract class BaseSecretsProvider extends Object implements SecretsProvider, AutoCloseable
Implements SecretsProvider on top of five primitives a service provides (SPEC section 3). Closing the provider stops every watch.
  • Constructor Details

    • BaseSecretsProvider

      protected BaseSecretsProvider()
      Creates the provider.
  • Method Details

    • fetchSecret

      protected abstract Optional<SecretValue> fetchSecret(String name, GetOptions opts)
      Reads one secret.
      Parameters:
      name - full secret name (validated, non-empty)
      opts - version / path
      Returns:
      the value, or empty when missing
    • listSecrets

      protected abstract List<SecretMetadata> listSecrets(String path)
      Lists secrets under a prefix or folder (order does not matter; the base class sorts).
      Parameters:
      path - prefix or folder, "" for the root
      Returns:
      the metadata with full names
    • putSecret

      protected abstract String putSecret(String name, byte[] value, SetOptions opts)
      Writes a secret.
      Parameters:
      name - full secret name
      value - bytes to store
      opts - path / cas / tags / description
      Returns:
      the new version, or ""
    • removeSecret

      protected abstract void removeSecret(String name, DeleteOptions opts)
      Deletes a secret.
      Parameters:
      name - full secret name
      opts - path / versions / permanent
      Throws:
      NotFoundException - when the secret does not exist
    • fetchMetadata

      protected abstract Optional<SecretMetadata> fetchMetadata(String name, GetOptions opts)
      Reads metadata.
      Parameters:
      name - full secret name
      opts - version / path
      Returns:
      the metadata, or empty when missing
    • get

      public Optional<SecretValue> get(String name, GetOptions opts)
      Description copied from interface: SecretsProvider
      Reads a secret.
      Specified by:
      get in interface SecretsProvider
      Parameters:
      name - full secret name
      opts - version / path
      Returns:
      the value, or empty when missing
    • list

      public List<SecretMetadata> list(String prefixOrPath)
      Description copied from interface: SecretsProvider
      Lists secrets (names and metadata, never values) sorted by name.
      Specified by:
      list in interface SecretsProvider
      Parameters:
      prefixOrPath - prefix or folder; empty for the root
      Returns:
      the metadata
    • getAll

      public Map<String,SecretValue> getAll(String path)
      Returns the secrets directly under path: names whose remainder after the path holds no further /.
      Specified by:
      getAll in interface SecretsProvider
      Parameters:
      path - folder / prefix; empty for the root
      Returns:
      full name to value
    • set

      public String set(String name, Object value, SetOptions opts)
      Description copied from interface: SecretsProvider
      Writes a secret. A String is stored as UTF-8, byte[] as is, SecretValue / Secret by their content, anything else JSON-encoded.
      Specified by:
      set in interface SecretsProvider
      Parameters:
      name - full secret name
      value - the value
      opts - path / cas / tags / description
      Returns:
      the new version, or "" when the service has no versions
    • toBytes

      public static byte[] toBytes(Object value)
      Converts a value for set: String → UTF-8, byte[] as is, SecretValue and Secret by content, anything else JSON-encoded.
      Parameters:
      value - the value
      Returns:
      the bytes
      Throws:
      ValidationException - when the value is null or cannot be encoded
    • delete

      public void delete(String name, DeleteOptions opts)
      Description copied from interface: SecretsProvider
      Deletes a secret.
      Specified by:
      delete in interface SecretsProvider
      Parameters:
      name - full secret name
      opts - path / versions / permanent
    • metadata

      public Optional<SecretMetadata> metadata(String name, GetOptions opts)
      Description copied from interface: SecretsProvider
      Reads a secret's metadata.
      Specified by:
      metadata in interface SecretsProvider
      Parameters:
      name - full secret name
      opts - version / path
      Returns:
      the metadata, or empty when missing
    • watch

      public WatchHandle watch(String name, Duration interval, WatchListener listener, WatchOptions opts)
      Description copied from interface: SecretsProvider
      Polls a secret and reports changes (version, or SHA-256 of the value when unversioned), including deletion. Errors go to WatchOptions.onError() and polling continues.
      Specified by:
      watch in interface SecretsProvider
      Parameters:
      name - full secret name
      interval - polling interval
      listener - change callback
      opts - error callback
      Returns:
      the handle; close() of the provider stops every watch
    • isClosed

      public boolean isClosed()
      Returns whether close() was called.
      Returns:
      true once closed
    • ensureOpen

      protected final void ensureOpen(String operation)
      Raises CancelledException once the provider is closed (SPEC: any call on a closed client raises CANCELLED). The public operations call it; service operations can too.
      Parameters:
      operation - operation name for the message
      Throws:
      CancelledException - after close()
    • close

      public void close()
      Stops every watch; later calls raise CancelledException. Idempotent. Subclasses overriding this must call super.close().
      Specified by:
      close in interface AutoCloseable