com.github.triceo.robozonky.common.secrets

Interface SecretProvider

public interface SecretProvider

Implementations provide various ways of storing sensitive information, such as passwords or access tokens. Users shall not be given access to these children - instead, they should get them by calling static methods on this class, such as keyStoreBased(KeyStoreHandler) or fallback(String, char[]).

Method Summary

Modifier and Type	Method and Description
boolean	deleteToken() Delete the stored token, if any.
static SecretProvider	fallback(String username, char... password) For cases where there is no KeyStore support available in JDK, this secret provider stores all secrets in plain text.
char[]	getPassword() Retrieve password used to connect to Zonky API.
Optional<char[]>	getSecret(String secretId) Retrieve a secret stored through setSecret(String, char[]).
Optional<Reader>	getToken() Retrieve serialization of Zonky's OAuth token.
String	getUsername() Retrieve username used to connect to Zonky API.
boolean	isPersistent() Whether or not this provider will store all data in such a way that it survives JVM restart.
static SecretProvider	keyStoreBased(KeyStoreHandler ksh) Create a @KeyStore-based provider based on a given key store.
static SecretProvider	keyStoreBased(KeyStoreHandler ksh, String user, char... password) Create a @KeyStore-based provider based on a given key store, filled with initial username and password.
boolean	setSecret(String secretId, char... secret) Store a secret.
boolean	setToken(Reader token) Store serialization of Zonky's OAuth token.

Method Detail

keyStoreBased

static SecretProvider keyStoreBased(KeyStoreHandler ksh)

Create a @KeyStore-based provider based on a given key store.

Parameters:

ksh - Initialized KeyStore for the provider to work with.

Returns:

The provider.

keyStoreBased

static SecretProvider keyStoreBased(KeyStoreHandler ksh,
                                    String user,
                                    char... password)

Create a @KeyStore-based provider based on a given key store, filled with initial username and password.

Parameters:

ksh - Initialized KeyStore for the provider to work with.

user - Zonky username to store in the key store.

password - Zonky password to store in the key store.

Returns:

The provider.

fallback

static SecretProvider fallback(String username,
                               char... password)

For cases where there is no KeyStore support available in JDK, this secret provider stores all secrets in plain text.

Parameters:

username - Zonky username.

password - Zonky password.

Returns:

The provider.

getPassword

char[] getPassword()

Retrieve password used to connect to Zonky API.

Returns:

The password.

getUsername

String getUsername()

Retrieve username used to connect to Zonky API.

Returns:

The username.

getToken

Optional<Reader> getToken()

Retrieve serialization of Zonky's OAuth token.

Returns:

Present if setToken(Reader) previously called, unless deleteToken() was called after that.

setToken

boolean setToken(Reader token)

Store serialization of Zonky's OAuth token.

Parameters:

token - The serialization of the token to be stored.

Returns:

True if successful.

getSecret

Optional<char[]> getSecret(String secretId)

Retrieve a secret stored through setSecret(String, char[]).

Parameters:

secretId - ID of the secret to retrieve.

Returns:

The secret, if found.

setSecret

boolean setSecret(String secretId,
                  char... secret)

Store a secret.

Parameters:

secretId - ID of the secret.

secret - The secret to store.

Returns:

True if successful.

deleteToken

boolean deleteToken()

Delete the stored token, if any.

Returns:

True if no token stored anymore.

isPersistent

boolean isPersistent()

Whether or not this provider will store all data in such a way that it survives JVM restart.

Returns:

True if the storage is persistent.