Class BaseSecretsProvider
java.lang.Object
codes.grow.packages.vault.secrets.BaseSecretsProvider
- All Implemented Interfaces:
SecretsProvider,AutoCloseable
- Direct Known Subclasses:
InMemorySecretsProvider,VaultSecretsProvider
Implements
SecretsProvider on top of five primitives a service provides (SPEC section 3).
Closing the provider stops every watch.-
Field Summary
Fields inherited from interface codes.grow.packages.vault.secrets.SecretsProvider
NUMBER -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Stops every watch; later calls raiseCancelledException.voiddelete(String name, DeleteOptions opts) Deletes a secret.protected final voidensureOpen(String operation) RaisesCancelledExceptiononce the provider is closed (SPEC: any call on a closed client raisesCANCELLED).protected abstract Optional<SecretMetadata> fetchMetadata(String name, GetOptions opts) Reads metadata.protected abstract Optional<SecretValue> fetchSecret(String name, GetOptions opts) Reads one secret.get(String name, GetOptions opts) Reads a secret.Returns the secrets directly underpath: names whose remainder after the path holds no further/.booleanisClosed()Returns whetherclose()was called.Lists secrets (names and metadata, never values) sorted by name.protected abstract List<SecretMetadata> listSecrets(String path) Lists secrets under a prefix or folder (order does not matter; the base class sorts).metadata(String name, GetOptions opts) Reads a secret's metadata.protected abstract StringputSecret(String name, byte[] value, SetOptions opts) Writes a secret.protected abstract voidremoveSecret(String name, DeleteOptions opts) Deletes a secret.set(String name, Object value, SetOptions opts) Writes a secret.static byte[]Converts a value forset:String→ UTF-8,byte[]as is,SecretValueandSecretby content, anything else JSON-encoded.watch(String name, Duration interval, WatchListener listener, WatchOptions opts) Polls a secret and reports changes (version, or SHA-256 of the value when unversioned), including deletion.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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
-
Constructor Details
-
BaseSecretsProvider
protected BaseSecretsProvider()Creates the provider.
-
-
Method Details
-
fetchSecret
Reads one secret.- Parameters:
name- full secret name (validated, non-empty)opts- version / path- Returns:
- the value, or empty when missing
-
listSecrets
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
Writes a secret.- Parameters:
name- full secret namevalue- bytes to storeopts- path / cas / tags / description- Returns:
- the new version, or
""
-
removeSecret
Deletes a secret.- Parameters:
name- full secret nameopts- path / versions / permanent- Throws:
NotFoundException- when the secret does not exist
-
fetchMetadata
Reads metadata.- Parameters:
name- full secret nameopts- version / path- Returns:
- the metadata, or empty when missing
-
get
Description copied from interface:SecretsProviderReads a secret.- Specified by:
getin interfaceSecretsProvider- Parameters:
name- full secret nameopts- version / path- Returns:
- the value, or empty when missing
-
list
Description copied from interface:SecretsProviderLists secrets (names and metadata, never values) sorted by name.- Specified by:
listin interfaceSecretsProvider- Parameters:
prefixOrPath- prefix or folder; empty for the root- Returns:
- the metadata
-
getAll
Returns the secrets directly underpath: names whose remainder after the path holds no further/.- Specified by:
getAllin interfaceSecretsProvider- Parameters:
path- folder / prefix; empty for the root- Returns:
- full name to value
-
set
Description copied from interface:SecretsProviderWrites a secret. AStringis stored as UTF-8,byte[]as is,SecretValue/Secretby their content, anything else JSON-encoded.- Specified by:
setin interfaceSecretsProvider- Parameters:
name- full secret namevalue- the valueopts- path / cas / tags / description- Returns:
- the new version, or
""when the service has no versions
-
toBytes
Converts a value forset:String→ UTF-8,byte[]as is,SecretValueandSecretby content, anything else JSON-encoded.- Parameters:
value- the value- Returns:
- the bytes
- Throws:
ValidationException- when the value is null or cannot be encoded
-
delete
Description copied from interface:SecretsProviderDeletes a secret.- Specified by:
deletein interfaceSecretsProvider- Parameters:
name- full secret nameopts- path / versions / permanent
-
metadata
Description copied from interface:SecretsProviderReads a secret's metadata.- Specified by:
metadatain interfaceSecretsProvider- Parameters:
name- full secret nameopts- version / path- Returns:
- the metadata, or empty when missing
-
watch
Description copied from interface:SecretsProviderPolls a secret and reports changes (version, or SHA-256 of the value when unversioned), including deletion. Errors go toWatchOptions.onError()and polling continues.- Specified by:
watchin interfaceSecretsProvider- Parameters:
name- full secret nameinterval- polling intervallistener- change callbackopts- error callback- Returns:
- the handle;
close()of the provider stops every watch
-
isClosed
public boolean isClosed()Returns whetherclose()was called.- Returns:
- true once closed
-
ensureOpen
RaisesCancelledExceptiononce the provider is closed (SPEC: any call on a closed client raisesCANCELLED). The public operations call it; service operations can too.- Parameters:
operation- operation name for the message- Throws:
CancelledException- afterclose()
-
close
public void close()Stops every watch; later calls raiseCancelledException. Idempotent. Subclasses overriding this must callsuper.close().- Specified by:
closein interfaceAutoCloseable
-