Package org.forgerock.secrets.propertyresolver

Class FileSystemSecretStore

java.lang.Object

org.forgerock.secrets.propertyresolver.FileSystemSecretStore

All Implemented Interfaces:

Closeable, AutoCloseable, SecretStore<Secret>

public final class FileSystemSecretStore
extends Object
implements SecretStore<Secret>, Closeable

A SecretStore that reads secrets from a directory with the expectation that each file contains a separate secret. A maximum size of 2MB is imposed on files, and any file larger than this will be ignored.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileSystemSecretStore.FileSystemSecretStoreBuilder	A builder for more fluently creating a FileSystemSecretStore.

Field Summary

Fields inherited from interface org.forgerock.secrets.SecretStore

CLOCK, LEASE_EXPIRY_DURATION

Method Summary

Modifier and Type	Method	Description
void	close()
static FileSystemSecretStore.FileSystemSecretStoreBuilder	fileSystemSecretStoreBuilder(Path directory)	Creates a new FileSystemSecretStore builder.
<S extends Secret> Promise<S,NoSuchSecretException>	getActive(Purpose<S> purpose)	Returns the active secret for the given purpose.
<S extends Secret> Promise<S,NoSuchSecretException>	getNamed(Purpose<S> purpose, String name)	Returns the named secret from this store.
Class<Secret>	getStoredType()	The top-level class that this store is capable of storing.
<S extends Secret> Promise<Stream<S>,NeverThrowsException>	getValid(Purpose<S> purpose)	Returns all valid secrets for the given purpose from this store.
void	refresh()	Indicates that the store should refresh its secrets from the backing storage mechanism.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.secrets.SecretStore

retire, revoke, rotate

Method Detail

fileSystemSecretStoreBuilder

public static FileSystemSecretStore.FileSystemSecretStoreBuilder fileSystemSecretStoreBuilder(Path directory)

Creates a new FileSystemSecretStore builder.

Parameters:

directory - the directory to retrieve file-based secrets from

Returns:

a new builder

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getStoredType

public Class<Secret> getStoredType()

Description copied from interface: SecretStore

The top-level class that this store is capable of storing. This is a reification of the type parameter and can be used to lookup stores for a given type.

Specified by:

getStoredType in interface SecretStore<Secret>

Returns:

the top-most type that this store is capable of storing, typically either CryptoKey for key-stores, GenericSecret for password stores, or Secret if the store is capable of storing any type of secret.

getActive

public <S extends Secret> Promise<S,NoSuchSecretException> getActive(Purpose<S> purpose)

Description copied from interface: SecretStore

Returns the active secret for the given purpose.

Specified by:

getActive in interface SecretStore<Secret>

Type Parameters:

S - the type of secret.

Parameters:

purpose - the purpose for which a secret is required.

Returns:

the active secret from this store.

getNamed

public <S extends Secret> Promise<S,NoSuchSecretException> getNamed(Purpose<S> purpose,
                                                                          String name)

Description copied from interface: SecretStore

Returns the named secret from this store. The default implementation calls SecretStore.getValid(Purpose) and then returns the first valid key with a matching stable ID.

Specified by:

getNamed in interface SecretStore<Secret>

Type Parameters:

S - the type of secret.

Parameters:

purpose - the secret purpose.

name - the name (stable id) of the secret.

Returns:

a promise for the named secret, or a NoSuchSecretException promise if no such secret exists.

getValid

public <S extends Secret> Promise<Stream<S>,NeverThrowsException> getValid(Purpose<S> purpose)

Description copied from interface: SecretStore

Returns all valid secrets for the given purpose from this store.

Specified by:

getValid in interface SecretStore<Secret>

Type Parameters:

S - the type of secret.

Parameters:

purpose - the purpose.

Returns:

a stream of all valid secrets of the given type from this store, or an empty stream if none exist.

refresh

public void refresh()

Description copied from interface: SecretStore

Indicates that the store should refresh its secrets from the backing storage mechanism. This can be used to cause reload of a store after a secret rotation if the backend does not automatically detect such changes. Refresh may be an asynchronous operation and no guarantees are made about when clients of this secret store may see updated secrets after a call to refresh.

Specified by:

refresh in interface SecretStore<Secret>