io.digdag.spi

Interface SecretProvider

All Known Implementing Classes:

SecretProvider.ScopedSecretProvider

public interface SecretProvider

A VFS style secret access interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SecretProvider.ScopedSecretProvider A secret provider that implements a virtual subtree view.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getSecret(java.lang.String key) Get a secret identified by a key.
com.google.common.base.Optional<java.lang.String>	getSecretOptional(java.lang.String key) Get a secret identified by a key.
default SecretProvider	getSecrets(java.lang.String path) Get a view of a subtree of the secret VFS.

Method Detail

getSecret

default java.lang.String getSecret(java.lang.String key)

Get a secret identified by a key.

Parameters:

key - A key identifing the secret to get.

Returns:

A secret.

Throws:

SecretNotFoundException - if no matching secret was found.

getSecretOptional

com.google.common.base.Optional<java.lang.String> getSecretOptional(java.lang.String key)

Get a secret identified by a key.

Parameters:

key - A key identifing the secret to get.

Returns:

Optional.of(Object) with a secret or Optional.absent() if no matching secret was found.

getSecrets

default SecretProvider getSecrets(java.lang.String path)

Get a view of a subtree of the secret VFS. All secret accesses by the returned SecretProvider are prefixed by the specified path.