com.github.javakeyring

Class Keyring

java.lang.Object

com.github.javakeyring.Keyring

public class Keyring
extends Object

Keyring.

Method Summary

Modifier and Type	Method and Description
static Keyring	create() Creates an instance of Keyring using the a default backed based on operating system.
static Keyring	create(Keyrings keyring) Creates an instance of Keyring with specified backend.
void	deletePassword(String service, String account) Sets password to key store (Proxy method of KeyringBackend.setPassword)
String	getKeyStorePath() Gets path to key store (Proxy method of KeyringBackend.getKeyStorePath).
String	getPassword(String service, String account) Gets password from key store (Proxy method of KeyringBackend.getPassword).
boolean	isKeyStorePathRequired() Returns true if the backend directory uses some file to store passwords.
void	setKeyStorePath(String path) Sets path to key store (Proxy method of KeyringBackend.setKeyStorePath).
void	setPassword(String service, String account, String password) Sets password to key store (Proxy method of KeyringBackend.setPassword)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Keyring create()
                      throws BackendNotSupportedException

Creates an instance of Keyring using the a default backed based on operating system.

Returns:

a functional Keyring or a BackendNotSupportedException is thrown.

Throws:

BackendNotSupportedException - if the default backend for the operating system is unsupported.

create

public static Keyring create(Keyrings keyring)
                      throws BackendNotSupportedException

Creates an instance of Keyring with specified backend.

Parameters:

keyring - desired backend.

Returns:

a functional Keyring or a BackendNotSupportedException is thrown.

Throws:

BackendNotSupportedException - if the default backend for the operating system is unsupported.

getKeyStorePath

public String getKeyStorePath()

Gets path to key store (Proxy method of KeyringBackend.getKeyStorePath).

Returns:

path to the keystore.

setKeyStorePath

public void setKeyStorePath(String path)

Sets path to key store (Proxy method of KeyringBackend.setKeyStorePath).

Parameters:

path - Path to key store

isKeyStorePathRequired

public boolean isKeyStorePathRequired()

Returns true if the backend directory uses some file to store passwords. (Proxy method of KeyringBackend.isKeyStorePathRequired)

Returns:

if a path is required to store a password.

getPassword

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

Gets password from key store (Proxy method of KeyringBackend.getPassword).

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 - can't establish lock.

setPassword

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

Sets password to key store (Proxy method of KeyringBackend.setPassword)

Parameters:

service - Service name

account - Account name

password - Password

Throws:

PasswordSaveException - Thrown when an error happened while saving the password

LockException - can't establish lock.

deletePassword

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

Sets password to key store (Proxy method of KeyringBackend.setPassword)

Parameters:

service - Service name

account - Account name

Throws:

PasswordSaveException - Thrown when an error happened while saving the password

LockException - can't establish lock.