org.apache.ambari.server.security.encryption

Interface CredentialStore

All Known Implementing Classes:

AbstractCredentialStore, FileBasedCredentialStore, InMemoryCredentialStore

public interface CredentialStore

Method Summary

Modifier and Type	Method and Description
void	addCredential(String alias, Credential credential) Adds a new credential to this CredentialStore The supplied key will be converted into UTF-8 bytes before being stored.
boolean	containsCredential(String alias) Tests this CredentialStore for the existence of a credential with the specified alias
Credential	getCredential(String alias) Retrieves the specified credential from this CredentialStore
Set<String>	listCredentials() Returns a list of the alias names for the credentials stored in the CredentialStore
void	removeCredential(String alias) Removes the specified credential from this CredentialStore
void	setMasterKeyService(MasterKeyService masterKeyService) Sets the MasterKeyService for this CredentialStore

Method Detail

addCredential

void addCredential(String alias,
                   Credential credential)
            throws org.apache.ambari.server.AmbariException

Adds a new credential to this CredentialStore

The supplied key will be converted into UTF-8 bytes before being stored.

Parameters:

alias - a string declaring the alias (or name) of the credential

credential - the credential to store

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while storing the new credential

getCredential

Credential getCredential(String alias)
                  throws org.apache.ambari.server.AmbariException

Retrieves the specified credential from this CredentialStore

Parameters:

alias - a string declaring the alias (or name) of the credential

Returns:

a Credential or null of not found

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while retrieving the new credential

removeCredential

void removeCredential(String alias)
               throws org.apache.ambari.server.AmbariException

Removes the specified credential from this CredentialStore

Parameters:

alias - a string declaring the alias (or name) of the credential

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while removing the new credential

listCredentials

Set<String> listCredentials()
                     throws org.apache.ambari.server.AmbariException

Returns a list of the alias names for the credentials stored in the CredentialStore

Returns:

a Set of Strings representing alias names for the credentials stored in the CredentialStore

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while searching forthe credential

containsCredential

boolean containsCredential(String alias)
                    throws org.apache.ambari.server.AmbariException

Tests this CredentialStore for the existence of a credential with the specified alias

Parameters:

alias - a string declaring the alias (or name) of the credential

Returns:

true if the alias exists; otherwise false

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while searching forthe credential

setMasterKeyService

void setMasterKeyService(MasterKeyService masterKeyService)

Sets the MasterKeyService for this CredentialStore

Parameters:

masterKeyService - the MasterKeyService