com.github.javakeyring

Class KeyringBackend

java.lang.Object

com.github.javakeyring.KeyringBackend

Direct Known Subclasses:

GnomeKeyringBackend, OsxKeychainBackend, UnencryptedMemoryBackend, WindowsDpApiBackend

public abstract class KeyringBackend
extends Object

java-keyring backend interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	keyStorePath Path to key store.

Constructor Summary

Constructors

Constructor and Description
KeyringBackend()

Method Summary

Modifier and Type	Method and Description
abstract void	deletePassword(String service, String account)
abstract String	getId() Gets backend Id.
String	getKeyStorePath() Gets path to key store.
abstract String	getPassword(String service, String account) Gets password from key store.
abstract boolean	isKeyStorePathRequired() Returns true if the backend directory uses some file to store passwords.
abstract boolean	isSupported() Returns true when the backend is supported.
void	setKeyStorePath(String path) Sets path to key store.
abstract void	setPassword(String service, String account, String password) Sets password to key store.

Methods inherited from class java.lang.Object

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

Field Detail

keyStorePath

protected String keyStorePath

Path to key store.

Constructor Detail

KeyringBackend

public KeyringBackend()

Method Detail

getId

public abstract String getId()

Gets backend Id.

Returns:

the identifier for the backend.

getKeyStorePath

public String getKeyStorePath()

Gets path to key store.

Returns:

a keystore path (if required by backend)

setKeyStorePath

public void setKeyStorePath(String path)

Sets path to key store.

Parameters:

path - Path to key store

isSupported

public abstract boolean isSupported()

Returns true when the backend is supported.

Returns:

true if the backend will function on the machine.

isKeyStorePathRequired

public abstract boolean isKeyStorePathRequired()

Returns true if the backend directory uses some file to store passwords.

Returns:

true if a key store path is required.

getPassword

public abstract String getPassword(String service,
                                   String account)
                            throws LockException,
                                   PasswordRetrievalException

Gets password from key store.

Parameters:

service - Service name

account - Account name

Returns:

Password related to specified service and account

Throws:

PasswordRetrievalException - Thrown when an error happened while getting password

LockException - Thrown when an error happened while getting password

setPassword

public abstract void setPassword(String service,
                                 String account,
                                 String password)
                          throws LockException,
                                 PasswordSaveException

Sets password to key store.

Parameters:

service - Service name

account - Account name

password - Password

Throws:

PasswordSaveException - Thrown when an error happened while saving the password

LockException - Thrown when an error happened while getting password

deletePassword

public abstract void deletePassword(String service,
                                    String account)
                             throws LockException,
                                    PasswordSaveException

Throws:

LockException

PasswordSaveException