org.apache.hadoop.fs.azure

Interface KeyProvider

All Known Implementing Classes:

ShellDecryptionKeyProvider, SimpleKeyProvider

@InterfaceAudience.Private
public interface KeyProvider

The interface that every Azure file system key provider must implement.

Method Summary

Modifier and Type	Method and Description
String	getStorageAccountKey(String accountName, org.apache.hadoop.conf.Configuration conf) Key providers must implement this method.

Method Detail

getStorageAccountKey

String getStorageAccountKey(String accountName,
                            org.apache.hadoop.conf.Configuration conf)
                     throws KeyProviderException

Key providers must implement this method. Given a list of configuration parameters for the specified Azure storage account, retrieve the plaintext storage account key.

Parameters:

accountName - the storage account name

conf - Hadoop configuration parameters

Returns:

the plaintext storage account key

Throws:

KeyProviderException - Thrown if there is a problem instantiating a KeyProvider or retrieving a key using a KeyProvider object.