Package overit.geocall.secrets

Class CachedSecretsManager

java.lang.Object

overit.geocall.secrets.CachedSecretsManager

All Implemented Interfaces:

SecretsManager

public class CachedSecretsManager
extends Object
implements SecretsManager

SecretsManager implementation that get secrets from a remote secret manager, storing them in a local cache and in a Redis cache, to optimize subsequent secret calls.

Field Summary

Fields inherited from interface overit.geocall.secrets.SecretsManager

CURRENT_SUFFIX, LOG, NAME_CANNOT_BE_NULL, PREVIOUS_SUFFIX, THE_SECRET_HAS_NOT_BEEN_FOUND_FOR_THE_VERSION, VERSION_ID_CANNOT_BE_NULL

Constructor Summary

Constructors

Constructor	Description
CachedSecretsManager(Long companyId, SecretsManagerClient client)	Returns a new CachedSecretsManager using the provided parameters.

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(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.

Methods inherited from class java.lang.Object

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

Constructor Details

CachedSecretsManager

public CachedSecretsManager(Long companyId,
 SecretsManagerClient client)

Returns a new CachedSecretsManager using the provided parameters.

Parameters:

companyId - Long about the company ID. Use null value if the secret doesn't belong to any company but is shared across all of them

client - SecretsManagerClient about the secrets manager client.

Method Details

get

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

Description copied from interface: SecretsManager

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

Specified by:

get in interface SecretsManager

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

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

Description copied from interface: SecretsManager

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

Specified by:

get in interface SecretsManager

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

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

Description copied from interface: SecretsManager

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

Specified by:

getPrevious in interface SecretsManager

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

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

Description copied from interface: SecretsManager

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

Specified by:

optionalGet in interface SecretsManager

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

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

Description copied from interface: SecretsManager

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

Specified by:

optionalGet in interface SecretsManager

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

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

Description copied from interface: SecretsManager

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

Specified by:

optionalGetPrevious in interface SecretsManager

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

public void clearCache()

Description copied from interface: SecretsManager

Clears all the secrets saved in a local cache.

Specified by:

clearCache in interface SecretsManager

removeFromCache

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

Description copied from interface: SecretsManager

Removes a Secret from the local cache if present.

Specified by:

removeFromCache in interface SecretsManager

Parameters:

name - the unique name of the secret.

Throws:

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

removeFromCache

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

Description copied from interface: SecretsManager

Removes a Secret from the local cache if present.

Specified by:

removeFromCache in interface SecretsManager

Parameters:

name - the unique name of the secret

versionId - the version identifier of the secret