org.apache.ambari.server.security.encryption

Interface CredentialStoreService

All Known Implementing Classes:

CredentialStoreServiceImpl

public interface CredentialStoreService

Method Summary

Modifier and Type	Method and Description
boolean	containsCredential(String clusterName, String alias) Tests to see if the requested alias exists in any CredentialStore
boolean	containsCredential(String clusterName, String alias, CredentialStoreType credentialStoreType) Tests to see if the requested alias exists in ether the persistent or the temporary CredentialStore
Credential	getCredential(String clusterName, String alias) Retrieves the specified credential looking in the temporary and then the persistent CredentialStore
Credential	getCredential(String clusterName, String alias, CredentialStoreType credentialStoreType) Retrieves the specified credential looking in ether the persistent or the temporary CredentialStore
CredentialStoreType	getCredentialStoreType(String clusterName, String alias) Gets the type of the credential store used to store the requested credential
boolean	isInitialized() Tests this CredentialStoreService to check if it has been properly initialized
boolean	isInitialized(CredentialStoreType credentialStoreType) Tests this CredentialStoreService to check if ether the persistent or the temporary CredentialStore has been properly initialized
Map<String,CredentialStoreType>	listCredentials(String clusterName) Maps the existing alias names to their relevant credential store types.
void	removeCredential(String clusterName, String alias) Removes the specified credential from all CredentialStores
void	removeCredential(String clusterName, String alias, CredentialStoreType credentialStoreType) Removes the specified credential from ether the persistent or the temporary CredentialStore
void	setCredential(String clusterName, String alias, Credential credential, CredentialStoreType credentialStoreType) Adds a new credential to ether the persistent or the temporary CredentialStore The supplied key will be converted into UTF-8 bytes before being stored.

Method Detail

setCredential

void setCredential(String clusterName,
                   String alias,
                   Credential credential,
                   CredentialStoreType credentialStoreType)
            throws org.apache.ambari.server.AmbariException

Adds a new credential to ether the persistent or the temporary CredentialStore

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

Parameters:

clusterName - the name of the cluster the credential is related to

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

credential - the credential value to store

credentialStoreType - a CredentialStoreType indicating which credential store facility to use

Throws:

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

getCredential

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

Retrieves the specified credential looking in the temporary and then the persistent CredentialStore

Parameters:

clusterName - the name of the cluster the credential is related to

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

Returns:

the requested Credential

Throws:

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

getCredential

Credential getCredential(String clusterName,
                         String alias,
                         CredentialStoreType credentialStoreType)
                  throws org.apache.ambari.server.AmbariException

Retrieves the specified credential looking in ether the persistent or the temporary CredentialStore

Parameters:

clusterName - the name of the cluster this credential is related to

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

credentialStoreType - a CredentialStoreType indicating which credential store facility to use

Returns:

the requested Credential

Throws:

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

removeCredential

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

Removes the specified credential from all CredentialStores

Parameters:

clusterName - the name of the cluster this credential is related to

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

Throws:

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

removeCredential

void removeCredential(String clusterName,
                      String alias,
                      CredentialStoreType credentialStoreType)
               throws org.apache.ambari.server.AmbariException

Removes the specified credential from ether the persistent or the temporary CredentialStore

Parameters:

clusterName - the name of the cluster this credential is related to

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

credentialStoreType - a CredentialStoreType indicating which credential store facility to use

Throws:

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

containsCredential

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

Tests to see if the requested alias exists in any CredentialStore

Parameters:

clusterName - the name of the cluster this credential is related to

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

Returns:

true if it exists; otherwise false

Throws:

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

containsCredential

boolean containsCredential(String clusterName,
                           String alias,
                           CredentialStoreType credentialStoreType)
                    throws org.apache.ambari.server.AmbariException

Tests to see if the requested alias exists in ether the persistent or the temporary CredentialStore

Parameters:

clusterName - the name of the cluster this credential is related to

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

credentialStoreType - a CredentialStoreType indicating which credential store facility to use

Returns:

true if it exists; otherwise false

Throws:

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

getCredentialStoreType

CredentialStoreType getCredentialStoreType(String clusterName,
                                           String alias)
                                    throws org.apache.ambari.server.AmbariException

Gets the type of the credential store used to store the requested credential

Parameters:

clusterName - the name of the cluster this credential is related to

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

Returns:

a CredentialStoreType

Throws:

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

listCredentials

Map<String,CredentialStoreType> listCredentials(String clusterName)
                                         throws org.apache.ambari.server.AmbariException

Maps the existing alias names to their relevant credential store types.

Parameters:

clusterName - the name of the cluster this credential is related to

Returns:

a map of alias names to CredentialStoreTypes

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while searching for the credentials

isInitialized

boolean isInitialized()

Tests this CredentialStoreService to check if it has been properly initialized

Returns:

true if initialized; otherwise false

isInitialized

boolean isInitialized(CredentialStoreType credentialStoreType)

Tests this CredentialStoreService to check if ether the persistent or the temporary CredentialStore has been properly initialized

Parameters:

credentialStoreType - a CredentialStoreType indicating which credential store facility to use

Returns:

true if initialized; otherwise false