de.qaware.seu.as.code.plugins.credentials

Interface CredentialsStorage

All Known Implementing Classes:

CredentialsStorage.None, KeychainCredentialsStorage, PropertyCredentialsStorage

public interface CredentialsStorage

This is the main interface to store and handle credentials. Platform specific implementations that do the heavy lifting of securely storing the credentials.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CredentialsStorage.None NoOp implementation of a credential storage.

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	UTF_8 The default charset to use for credential storage.

Method Summary

Modifier and Type	Method and Description
void	clearCredentials(java.lang.String service) Clear the stored credentials for the given service name.
Credentials	findCredentials(java.lang.String service) Find the credentials for the given service name.
void	setCredentials(java.lang.String service, Credentials credentials) Set the given credentials object for the specified service.
void	setCredentials(java.lang.String service, java.lang.String username, char[] password) Set the given username and password as credential for the specified service.

Field Detail

UTF_8

static final java.nio.charset.Charset UTF_8

The default charset to use for credential storage.

Method Detail

findCredentials

Credentials findCredentials(java.lang.String service)
                     throws CredentialsException

Find the credentials for the given service name.

Parameters:

service - the service name

Returns:

the stored Credentials or NULL if not present

Throws:

CredentialsException - error finding the credentials

setCredentials

void setCredentials(java.lang.String service,
                    java.lang.String username,
                    char[] password)
             throws CredentialsException

Set the given username and password as credential for the specified service.

Parameters:

service - the service name

username - the username to set

password - the password to set

Throws:

CredentialsException - error storing the credentials

setCredentials

void setCredentials(java.lang.String service,
                    Credentials credentials)
             throws CredentialsException

Set the given credentials object for the specified service.

Parameters:

service - the service name

credentials - the credentials object

Throws:

CredentialsException - error storing the credentials

clearCredentials

void clearCredentials(java.lang.String service)
               throws CredentialsException

Clear the stored credentials for the given service name.

Parameters:

service - the service name

Throws:

CredentialsException - error clearing the credentials