Package overit.geocall.secrets

Interface SecretsManager

All Known Implementing Classes:

CachedSecretsManager

public interface SecretsManager

Interface representing a generic secret manager.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURRENT_SUFFIX
static final LogChannel	LOG
static final String	NAME_CANNOT_BE_NULL
static final String	PREVIOUS_SUFFIX
static final String	THE_SECRET_HAS_NOT_BEEN_FOUND_FOR_THE_VERSION
static final String	VERSION_ID_CANNOT_BE_NULL

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clears all the secrets saved in a local cache.
Secret	get(@NotNull String name)	Fetches a Secret by its name, returning it if found, otherwise a SecretsManagerException is thrown.
Secret	get(@NotNull String name, @NotNull String versionId)	Fetches a Secret by its name and versionId, returning it if found, otherwise a SecretsManagerException is thrown.
Secret	getPrevious(@NotNull String name)	Retrieves the previous value of the Secret if found, otherwise a SecretsManagerException is thrown.
Optional<Secret>	optionalGet(@NotNull String name)	Fetches a Secret by its name returning an Optional (Optional.empty() if not found).
Optional<Secret>	optionalGet(@NotNull String name, @NotNull String versionId)	Fetches a Secret by its name and versionId returning an Optional (Optional.empty() if not found).
Optional<Secret>	optionalGetPrevious(@NotNull String name)	Fetches the previous value of a Secret by its name returning an Optional (Optional.empty() if not found).
void	removeFromCache(@NotNull String name)	Removes a Secret from the local cache if present.
void	removeFromCache(@NotNull String name, @NotNull String versionId)	Removes a Secret from the local cache if present.

Field Details

LOG

static final LogChannel LOG

NAME_CANNOT_BE_NULL

static final String NAME_CANNOT_BE_NULL

See Also:

• Constant Field Values

VERSION_ID_CANNOT_BE_NULL

static final String VERSION_ID_CANNOT_BE_NULL

See Also:

• Constant Field Values

THE_SECRET_HAS_NOT_BEEN_FOUND_FOR_THE_VERSION

static final String THE_SECRET_HAS_NOT_BEEN_FOUND_FOR_THE_VERSION

See Also:

• Constant Field Values

CURRENT_SUFFIX

static final String CURRENT_SUFFIX

See Also:

• Constant Field Values

PREVIOUS_SUFFIX

static final String PREVIOUS_SUFFIX

See Also:

• Constant Field Values

Method Details

get

Secret get(@NotNull
 @NotNull String name)
    throws SecretsManagerException

Fetches a Secret by its name, returning it if found, otherwise a SecretsManagerException is thrown.

Parameters:

name - the unique name of the secret

Returns:

the secret if found, otherwise a SecretsManagerException is thrown.

Throws:

SecretsManagerException - in case of errors while communicating with the secret manager or in case the requested secret has not been found.

get

Secret get(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String versionId)
    throws SecretsManagerException

Fetches a Secret by its name and versionId, returning it if found, otherwise a SecretsManagerException is thrown.

Parameters:

name - the unique name of the secret

versionId - the version identifier of the secret

Returns:

the secret if found, otherwise a SecretsManagerException is thrown.

Throws:

SecretsManagerException - in case of errors while communicating with the secret manager or in case the requested secret has not been found.

getPrevious

Secret getPrevious(@NotNull
 @NotNull String name)
            throws SecretsManagerException

Retrieves the previous value of the Secret if found, otherwise a SecretsManagerException is thrown.

Parameters:

name - the unique name of the secret

Returns:

the previous value of the secret if found, otherwise a SecretsManagerException is thrown.

Throws:

SecretsManagerException - in case of errors while communicating with the secret manager or in case the requested secret has not been found.

optionalGet

Optional<Secret> optionalGet(@NotNull
 @NotNull String name)
                      throws SecretsManagerException

Fetches a Secret by its name returning an Optional (Optional.empty() if not found).

Parameters:

name - the unique name of the secret

Returns:

the Optional of the secret (Optional.empty() if not found)

Throws:

SecretsManagerException - in case of errors while communicating with the secret manager.

optionalGet

Optional<Secret> optionalGet(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String versionId)
                      throws SecretsManagerException

Fetches a Secret by its name and versionId returning an Optional (Optional.empty() if not found).

Parameters:

name - the unique name of the secret

versionId - the version identifier of the secret

Returns:

the Optional of the secret (Optional.empty() if not found)

Throws:

SecretsManagerException - in case of errors while communicating with the secret manager.

optionalGetPrevious

Optional<Secret> optionalGetPrevious(@NotNull
 @NotNull String name)
                              throws SecretsManagerException

Fetches the previous value of a Secret by its name returning an Optional (Optional.empty() if not found).

Parameters:

name - the unique name of the secret

Returns:

the Optional of the secret (Optional.empty() if not found)

Throws:

SecretsManagerException - in case of errors while communicating with the secret manager.

clearCache

void clearCache()

Clears all the secrets saved in a local cache.

removeFromCache

void removeFromCache(@NotNull
 @NotNull String name)
              throws SecretsManagerException

Removes a Secret from the local cache if present.

Parameters:

name - the unique name of the secret.

Throws:

SecretsManagerException - in case of errors while communicating with the secret manager.

removeFromCache

void removeFromCache(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String versionId)

Removes a Secret from the local cache if present.

Parameters:

name - the unique name of the secret

versionId - the version identifier of the secret