org.apache.hadoop.fs.azure

Class RemoteSASKeyGeneratorImpl

java.lang.Object

org.apache.hadoop.fs.azure.SASKeyGeneratorImpl

org.apache.hadoop.fs.azure.RemoteSASKeyGeneratorImpl

All Implemented Interfaces:

SASKeyGeneratorInterface

public class RemoteSASKeyGeneratorImpl
extends SASKeyGeneratorImpl

Class implementing a RemoteSASKeyGenerator. This class uses the url passed in via the Configuration to make a rest call to generate the required SAS Key.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CRED_SERVICE_URLS Configuration parameter name expected in the Configuration object to provide the url of the remote service "fs.azure.cred.service.urls"
static org.slf4j.Logger	LOG
static String	SAS_KEY_GENERATOR_HTTP_CLIENT_RETRY_POLICY_ENABLED_KEY Configuration key to enable http retry policy for SAS Key generation.
static String	SAS_KEY_GENERATOR_HTTP_CLIENT_RETRY_POLICY_SPEC_KEY Configuration key for SAS Key Generation http retry policy spec.

Fields inherited from class org.apache.hadoop.fs.azure.SASKeyGeneratorImpl

DEFAULT_CONTAINER_SAS_KEY_PERIOD, KEY_SAS_KEY_EXPIRY_PERIOD

Constructor Summary

Constructors

Constructor and Description
RemoteSASKeyGeneratorImpl(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
URI	getContainerSASUri(String storageAccount, String container) Interface method to retrieve SAS Key for a container within the storage account.
URI	getRelativeBlobSASUri(String storageAccount, String container, String relativePath) Interface method to retrieve SAS Key for a blob within the container of the storage account.
void	initialize(org.apache.hadoop.conf.Configuration conf)

Methods inherited from class org.apache.hadoop.fs.azure.SASKeyGeneratorImpl

getConf, getSasKeyExpiryPeriod

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

public static final org.slf4j.Logger LOG

KEY_CRED_SERVICE_URLS

public static final String KEY_CRED_SERVICE_URLS

Configuration parameter name expected in the Configuration object to provide the url of the remote service "fs.azure.cred.service.urls"

See Also:

Constant Field Values

SAS_KEY_GENERATOR_HTTP_CLIENT_RETRY_POLICY_ENABLED_KEY

public static final String SAS_KEY_GENERATOR_HTTP_CLIENT_RETRY_POLICY_ENABLED_KEY

Configuration key to enable http retry policy for SAS Key generation. "fs.azure.saskeygenerator.http.retry.policy.enabled"

See Also:

Constant Field Values

SAS_KEY_GENERATOR_HTTP_CLIENT_RETRY_POLICY_SPEC_KEY

public static final String SAS_KEY_GENERATOR_HTTP_CLIENT_RETRY_POLICY_SPEC_KEY

Configuration key for SAS Key Generation http retry policy spec. "fs.azure.saskeygenerator.http.retry.policy.spec"

See Also:

Constant Field Values

Constructor Detail

RemoteSASKeyGeneratorImpl

public RemoteSASKeyGeneratorImpl(org.apache.hadoop.conf.Configuration conf)

Method Detail

initialize

public void initialize(org.apache.hadoop.conf.Configuration conf)
                throws IOException

Throws:

IOException

getContainerSASUri

public URI getContainerSASUri(String storageAccount,
                              String container)
                       throws SASKeyGenerationException

Description copied from interface: SASKeyGeneratorInterface

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

Parameters:

storageAccount - - 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

public URI getRelativeBlobSASUri(String storageAccount,
                                 String container,
                                 String relativePath)
                          throws SASKeyGenerationException

Description copied from interface: SASKeyGeneratorInterface

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

Parameters:

storageAccount - - 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.