com.microsoft.alm.storage.posix.internal

Class GnomeKeyringBackedSecureStore<E extends Secret>

java.lang.Object

com.microsoft.alm.storage.posix.internal.GnomeKeyringBackedSecureStore<E>

All Implemented Interfaces:

SecretStore<E>

Direct Known Subclasses:

GnomeKeyringBackedCredentialStore, GnomeKeyringBackedTokenPairStore, GnomeKeyringBackedTokenStore

public abstract class GnomeKeyringBackedSecureStore<E extends Secret>
extends Object
implements SecretStore<E>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_UNLOCK_KEYRING

Constructor Summary

Constructors

Constructor and Description
GnomeKeyringBackedSecureStore()

Method Summary

Modifier and Type	Method and Description
boolean	add(String key, E secret)
boolean	delete(String key)
protected abstract E	deserialize(String secret) Create a Secret from the stored string representation
E	get(String key) Read a secret from GNOME Keyring using its simple password API
protected abstract String	getType() Return the type of this secure store, used to match the secret in GNOME Keyring
static boolean	isGnomeKeyringSupported() Check for GNOME Keyring support on this platform
boolean	isSecure() GNOME Keyring is considered secure
protected abstract String	serialize(E secret) Create a string representation suitable to be saved as String

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_UNLOCK_KEYRING

public static final String ALLOW_UNLOCK_KEYRING

See Also:

Constant Field Values

Constructor Detail

GnomeKeyringBackedSecureStore

public GnomeKeyringBackedSecureStore()

Method Detail

deserialize

protected abstract E deserialize(String secret)

Create a Secret from the stored string representation

Parameters:

secret - password, oauth2 access token, or Personal Access Token

Returns:

a Secret from the input

serialize

protected abstract String serialize(E secret)

Create a string representation suitable to be saved as String

Parameters:

secret - password, oauth2 access token, or Personal Access Token

Returns:

a string representation of the secret

getType

protected abstract String getType()

Return the type of this secure store, used to match the secret in GNOME Keyring

Returns:

type string representation of the secret type

get

public E get(String key)

Read a secret from GNOME Keyring using its simple password API

Specified by:

get in interface SecretStore<E extends Secret>

Parameters:

key - for which a secret is associated with

Returns:

secret

delete

public boolean delete(String key)

Specified by:

delete in interface SecretStore<E extends Secret>

add

public boolean add(String key,
                   E secret)

Specified by:

add in interface SecretStore<E extends Secret>

isSecure

public boolean isSecure()

GNOME Keyring is considered secure

Specified by:

isSecure in interface SecretStore<E extends Secret>

Returns:

true for GNOME Keyring

isGnomeKeyringSupported

public static boolean isGnomeKeyringSupported()

Check for GNOME Keyring support on this platform

Returns:

true if gnome-keyring library is available; false otherwise