Package io.deephaven.enterprise.secrets

Class JsonFilesSecretsProvider

java.lang.Object

io.deephaven.enterprise.secrets.JsonFilesSecretsProvider

All Implemented Interfaces:

SecretsProvider

public class JsonFilesSecretsProvider
extends Object
implements SecretsProvider

A SecretsProvider that sources secrets from a file on disk in Property format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JsonFilesSecretsProvider.Factory	A factory to create a JsonFilesSecretsProvider from an XML Element.

Constructor Summary

Constructors

Constructor	Description
JsonFilesSecretsProvider(@NotNull Path secretsPath, int priority, @NotNull String providerName)	Create a new instance using the provided path to the secrets file.

Method Summary

Modifier and Type	Method	Description
String	describe()	Describe this provider for logging purposes.
int	getPriority()	Get the priority of this SecretsProvider.
String	getSecret(@NotNull String secretName)	Get the named secret.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JsonFilesSecretsProvider

public JsonFilesSecretsProvider(@NotNull
 @NotNull Path secretsPath,
 int priority,
 @NotNull
 @NotNull String providerName)

Create a new instance using the provided path to the secrets file.

Parameters:

secretsPath - the path to the secrets file.

priority - the priority

providerName - the name

Method Details

getPriority

public int getPriority()

Description copied from interface: SecretsProvider

Get the priority of this SecretsProvider. The SecretsService will visit providers in descending order of priority until one returns the requested secret.

Specified by:

getPriority in interface SecretsProvider

Returns:

the priority of this provider.

getSecret

public String getSecret(@NotNull
 @NotNull String secretName)

Description copied from interface: SecretsProvider

Get the named secret.

Specified by:

getSecret in interface SecretsProvider

Parameters:

secretName - the name of the secret

Returns:

the value of the named secret.

describe

public String describe()

Description copied from interface: SecretsProvider

Describe this provider for logging purposes.

Specified by:

describe in interface SecretsProvider

Returns:

a description of this provider.

toString

public String toString()

Overrides:

toString in class Object