Class SecretCache
java.lang.Object
codes.grow.packages.awssecretsmanager.secrets.SecretCache
- All Implemented Interfaces:
SecretsProvider,AutoCloseable
LRU cache in front of a
SecretsProvider (SPEC section 3).
Reads (get*, require, exists, getMany) are cached, including
negative results. A hit older than ttl * refreshAheadFactor starts one background
refresh; within ttl + staleWhileRevalidate a stale value is served while one refresh
runs; older entries are reloaded synchronously. Writes pass through and invalidate the name.
getAll, list and metadata are not cached.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from interface codes.grow.packages.awssecretsmanager.secrets.SecretsProvider
NUMBER -
Constructor Summary
ConstructorsConstructorDescriptionSecretCache(SecretsProvider provider) Creates a cache with the default options.SecretCache(SecretsProvider provider, SecretCache.Options options) Creates a cache. -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Drops every entry.voidclose()Clears the cache; later calls raiseCancelledException.voiddelete(String name, DeleteOptions opts) Deletes a secret.get(String name, GetOptions opts) Reads a secret.Returns every secret directly underpath(not recursive), sorted by name.voidinvalidate(String name) Drops every cached entry of a name (all versions and paths).Lists secrets (names and metadata, never values) sorted by name.metadata(String name, GetOptions opts) Reads a secret's metadata.set(String name, Object value, SetOptions opts) Writes a secret.stats()Returns the counters.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.awssecretsmanager.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
-
SecretCache
Creates a cache with the default options.- Parameters:
provider- the provider to cache
-
SecretCache
Creates a cache.- Parameters:
provider- the provider to cacheoptions- cache options
-
-
Method Details
-
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
-
invalidate
Drops every cached entry of a name (all versions and paths).- Parameters:
name- full secret name
-
clear
public void clear()Drops every entry. -
stats
Returns the counters.- Returns:
- a snapshot
-
getAll
Description copied from interface:SecretsProviderReturns every secret directly underpath(not recursive), sorted by name.- Specified by:
getAllin interfaceSecretsProvider- Parameters:
path- folder / prefix; empty for the root- Returns:
- full name to value
-
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
-
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
-
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
-
close
public void close()Clears the cache; later calls raiseCancelledException. The wrapped provider stays open (close it separately). Idempotent.- Specified by:
closein interfaceAutoCloseable
-