Package org.apache.hadoop.fs.azure

Interface SASKeyGeneratorInterface

All Known Implementing Classes:

LocalSASKeyGeneratorImpl, RemoteSASKeyGeneratorImpl, SASKeyGeneratorImpl

public interface SASKeyGeneratorInterface

Iterface used by AzureNativeFileSysteStore to retrieve SAS Keys for the respective azure storage entity. This interface is expected to be implemented in two modes: 1) Local Mode: In this mode SAS Keys are generated in same address space as the WASB. This will be primarily used for testing purposes. 2) Remote Mode: In this mode SAS Keys are generated in a sepearte process other than WASB and will be communicated via client.

Method Summary

Modifier and Type	Method	Description
java.net.URI	getContainerSASUri(java.lang.String accountName, java.lang.String container)	Interface method to retrieve SAS Key for a container within the storage account.
java.net.URI	getRelativeBlobSASUri(java.lang.String accountName, java.lang.String container, java.lang.String relativePath)	Interface method to retrieve SAS Key for a blob within the container of the storage account.

Method Detail

getContainerSASUri

java.net.URI getContainerSASUri(java.lang.String accountName,
                                java.lang.String container)
                         throws SASKeyGenerationException

Interface method to retrieve SAS Key for a container within the storage account.

Parameters:

accountName - - Storage account name

container - - Container name within the storage account.

Returns:

SAS URI for the container.

Throws:

SASKeyGenerationException - Exception that gets thrown during generation of SAS Key.

getRelativeBlobSASUri

java.net.URI getRelativeBlobSASUri(java.lang.String accountName,
                                   java.lang.String container,
                                   java.lang.String relativePath)
                            throws SASKeyGenerationException

Interface method to retrieve SAS Key for a blob within the container of the storage account.

Parameters:

accountName - - Storage account name

container - - Container name within the storage account.

relativePath - - Relative path within the container

Returns:

SAS URI for the relative path blob.

Throws:

SASKeyGenerationException - Exception that gets thrown during generation of SAS Key.