net.smoofyuniverse.keyring

Interface Keyring

All Known Implementing Classes:

CredentialManagerKeyring, KeychainKeyring, SecretServiceKeyring

public interface Keyring

A keyring.

Method Summary

Modifier and Type	Method and Description
static Keyring	create() Creates a keyring for the current OS.
java.lang.String	getBackendName() Gets the name of the backend.
java.lang.String	getPassword(java.lang.String service, java.lang.String account) Gets a password for the specified service and account.
void	setPassword(java.lang.String service, java.lang.String account, java.lang.String password) Sets a password for the specified service and account.
static void	validateAccount(java.lang.String account) Validates the account.
static void	validatePassword(java.lang.String password) Validates the password.
static void	validateService(java.lang.String service) Validates the service.

Method Detail

create

static Keyring create()
               throws UnsupportedBackendException

Creates a keyring for the current OS.

Returns:

The keyring.

Throws:

UnsupportedBackendException - if there is no backend available.

getBackendName

java.lang.String getBackendName()

Gets the name of the backend.

Returns:

The name.

getPassword

java.lang.String getPassword(java.lang.String service,
                             java.lang.String account)
                      throws PasswordAccessException

Gets a password for the specified service and account.

Parameters:

service - The service.

account - The account.

Returns:

The password or null if absent.

Throws:

PasswordAccessException - if any exception occurs while getting the password.

setPassword

void setPassword(java.lang.String service,
                 java.lang.String account,
                 java.lang.String password)
          throws PasswordAccessException

Sets a password for the specified service and account.

Parameters:

service - The service.

account - The account.

password - The password or null to remove.

Throws:

PasswordAccessException - if any exception occurs while saving the password.

validateService

static void validateService(java.lang.String service)

Validates the service. The service must be non-null and not empty.

Parameters:

service - The service.

validateAccount

static void validateAccount(java.lang.String account)

Validates the account. The account must be non-null.

Parameters:

account - The account.

validatePassword

static void validatePassword(java.lang.String password)

Validates the password. The password must not contains a NULL character.

Parameters:

password - The password.