Module com.microsoft.credentialstorage

Package com.microsoft.credentialstorage.implementation.posix.keyring

Class GnomeKeyringBackedTokenPairStore

java.lang.Object

com.microsoft.credentialstorage.implementation.posix.keyring.GnomeKeyringBackedSecureStore<StoredTokenPair>

com.microsoft.credentialstorage.implementation.posix.keyring.GnomeKeyringBackedTokenPairStore

All Implemented Interfaces:

SecretStore<StoredTokenPair>

public final class GnomeKeyringBackedTokenPairStore
extends GnomeKeyringBackedSecureStore<StoredTokenPair>

GNOME Keyring store for a token pair.

Field Summary

Fields inherited from class com.microsoft.credentialstorage.implementation.posix.keyring.GnomeKeyringBackedSecureStore

ALLOW_UNLOCK_KEYRING, APP_NAME, ATTRIBUTE_ACCOUNT, ATTRIBUTE_KEY, ATTRIBUTE_TYPE, INSTANCE, logger, SCHEMA

Constructor Summary

Constructors

Constructor	Description
GnomeKeyringBackedTokenPairStore()

Method Summary

Modifier and Type	Method	Description
boolean	add(String key, StoredTokenPair secret)	Save the secret identified by the key to this store.
protected StoredTokenPair	create(String username, char[] secret)	Create a Secret from the string representation
boolean	delete(String key)	Delete a secret from GNOME Keyring.
StoredTokenPair	get(String key)	Read a secret from GNOME Keyring using its item API to get attributes containing username.
protected String	getType()	Return the type of this secure store, used to match the secret in GNOME Keyring

Methods inherited from class com.microsoft.credentialstorage.implementation.posix.keyring.GnomeKeyringBackedSecureStore

checkResult, deleteSecret, isSecure, isSupported, readSecret, writeSecret

Methods inherited from class java.lang.Object

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

Constructor Detail

GnomeKeyringBackedTokenPairStore

public GnomeKeyringBackedTokenPairStore()

Method Detail

get

public StoredTokenPair get(String key)

Description copied from class: GnomeKeyringBackedSecureStore

Read a secret from GNOME Keyring using its item API to get attributes containing username.

Specified by:

get in interface SecretStore<StoredTokenPair>

Overrides:

get in class GnomeKeyringBackedSecureStore<StoredTokenPair>

Parameters:

key - for which a secret is associated with

Returns:

secret

add

public boolean add(String key,
                   StoredTokenPair secret)

Description copied from interface: SecretStore

Save the secret identified by the key to this store. Replace existing secret if it exists.

Parameters:

key - for which a secret is associated with

secret - secret to be stored

Returns:

true if secret is added successfully false otherwise

delete

public boolean delete(String key)

Description copied from class: GnomeKeyringBackedSecureStore

Delete a secret from GNOME Keyring.

Specified by:

delete in interface SecretStore<StoredTokenPair>

Overrides:

delete in class GnomeKeyringBackedSecureStore<StoredTokenPair>

Parameters:

key - for which a secret is associated with

Returns:

true if operation succeeded

create

protected StoredTokenPair create(String username,
                                 char[] secret)

Description copied from class: GnomeKeyringBackedSecureStore

Create a Secret from the string representation

Specified by:

create in class GnomeKeyringBackedSecureStore<StoredTokenPair>

Parameters:

username - username for the secret

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

Returns:

a Secret from the input

getType

protected String getType()

Description copied from class: GnomeKeyringBackedSecureStore

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

Specified by:

getType in class GnomeKeyringBackedSecureStore<StoredTokenPair>

Returns:

type string representation of the secret type