Package dev.enola.common.secret

Class PrefixingSecretManager

java.lang.Object

dev.enola.common.secret.PrefixingSecretManager

All Implemented Interfaces:

SecretManager

public class PrefixingSecretManager
extends Object
implements SecretManager

PrefixingSecretManager is a SecretManager that prefixes all keys with a given prefix.

This is useful, for example, to use a single SecretManager in a server environment for multiple users (or any other Subject), or in a desktop environment to store application-specific secrets on the user's desktop secret manager (like GNOME Keyring or macOS Keychain on Apple's Secure Enclave).

Constructor Summary

Constructors

Constructor	Description
PrefixingSecretManager(String prefix, SecretManager delegate)

Method Summary

Modifier and Type	Method	Description
void	delete(String key)	Deletes a secret from the manager.
Optional<Secret>	getOptional(String key)	Retrieves a secret by its key, with optionality.
void	store(String key, char[] value)	Stores a secret value associated with a unique key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.enola.common.secret.SecretManager

get

Constructor Details

PrefixingSecretManager

public PrefixingSecretManager(String prefix,
 SecretManager delegate)

Method Details

store

public void store(String key,
 char[] value)
           throws IOException

Description copied from interface: SecretManager

Stores a secret value associated with a unique key. The sensitive value is provided as a char array. Implementations will zero out the input value array immediately after calling this method for security. If a secret with the same key already exists, its value is overwritten.

Specified by:

store in interface SecretManager

Parameters:

key - The unique key (name) for the secret.

value - The sensitive secret value as a character array.

Throws:

IOException - If an error occurs while storing the secret.

getOptional

public Optional<Secret> getOptional(String key)
                             throws IOException

Description copied from interface: SecretManager

Retrieves a secret by its key, with optionality.

Specified by:

getOptional in interface SecretManager

Parameters:

key - The unique key (name) of the secret to retrieve.

Returns:

An Optional containing the Secret, if found.

Throws:

IOException - If an error occurs while retrieving the secret.

delete

public void delete(String key)
            throws IOException

Description copied from interface: SecretManager

Deletes a secret from the manager.

Specified by:

delete in interface SecretManager

Parameters:

key - The unique key (name) of the secret to delete.

Throws:

IOException - If an error occurs while deleting the secret.