com.github.javakeyring.windows

Class WindowsDpApiBackend

java.lang.Object

com.github.javakeyring.KeyringBackend

com.github.javakeyring.windows.WindowsDpApiBackend

public class WindowsDpApiBackend
extends KeyringBackend

Keyring backend which uses Windows DPAPI.

Field Summary

Fields inherited from class com.github.javakeyring.KeyringBackend

keyStorePath

Constructor Summary

Constructors

Constructor and Description
WindowsDpApiBackend()

Method Summary

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

Methods inherited from class com.github.javakeyring.KeyringBackend

getKeyStorePath, setKeyStorePath

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowsDpApiBackend

public WindowsDpApiBackend()

Method Detail

isSupported

public boolean isSupported()

Returns true when the backend is supported.

Specified by:

isSupported in class KeyringBackend

Returns:

true if the backend will function on the machine.

isKeyStorePathRequired

public boolean isKeyStorePathRequired()

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

Specified by:

isKeyStorePathRequired in class KeyringBackend

Returns:

true if a key store path is required.

getPassword

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

Gets password from key store.

Specified by:

getPassword in class KeyringBackend

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 void setPassword(String service,
                        String account,
                        String password)
                 throws LockException,
                        PasswordSaveException

Sets password to key store.

Specified by:

setPassword in class KeyringBackend

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 void deletePassword(String service,
                           String account)
                    throws LockException,
                           PasswordSaveException

Deletes password from the key store.

Specified by:

deletePassword in class KeyringBackend

Parameters:

service - Service name

account - Account name

Throws:

PasswordSaveException - Thrown when an error happened while saving the password

LockException

getId

public String getId()

Gets backend ID.

Specified by:

getId in class KeyringBackend

Returns:

the identifier for the backend.

getLockPath

public String getLockPath()

Returns path to a file for lock.

Returns:

the key store lock file location.