AbfsConfiguration (Apache Hadoop Azure support 3.3.1 API)

java.lang.Object
- org.apache.hadoop.fs.azurebfs.AbfsConfiguration

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class AbfsConfiguration
extends Object

Configuration for Azure Blob FileSystem.

Constructor Summary

Constructors
Constructor and Description

AbfsConfiguration(org.apache.hadoop.conf.Configuration rawConfig, String accountName)

Constructors
Constructor and Description
`AbfsConfiguration(org.apache.hadoop.conf.Configuration rawConfig, String accountName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accountConf(String key)` Appends an account name to a configuration key yielding the account-specific form.
`boolean`	`enableAbfsListIterator()`
`String`	`get(String key)` Returns the account-specific value if it exists, then looks for an account-agnostic value.
`<U> Class<? extends U>`	`getAccountAgnosticClass(String name, Class<? extends U> defaultValue, Class<U> xface)` Returns account-agnostic Class if it exists, else returns the default value.
`<T extends Enum<T>> T`	`getAccountAgnosticEnum(String name, T defaultValue)` Returns the account-agnostic enum value if it exists, else return default.
`String`	`getAccountName()` Gets the Azure Storage account name corresponding to this instance of configuration.
`<U> Class<? extends U>`	`getAccountSpecificClass(String name, Class<? extends U> defaultValue, Class<U> xface)` Returns the account-specific class if it exists, else returns default value.
`String`	`getAppendBlobDirs()`
`AuthType`	`getAuthType(String accountName)`
`String`	`getAzureAtomicRenameDirs()`
`String`	`getAzureBlockLocationHost()`
`long`	`getAzureBlockSize()`
`String`	`getAzureInfiniteLeaseDirs()`
`int`	`getBackoffIntervalMilliseconds()`
`boolean`	`getBoolean(String key, boolean defaultValue)` Returns the account-specific value if it exists, then looks for an account-agnostic value, and finally tries the default value.
`String`	`getClientProvidedEncryptionKey()`
`String`	`getClusterName()`
`String`	`getClusterType()`
`boolean`	`getCreateRemoteFileSystemDuringInitialization()`
`int`	`getCustomTokenFetchRetryCount()`
`String`	`getCustomUserAgentPrefix()`
`AbfsDelegationTokenManager`	`getDelegationTokenManager()`
`<T extends Enum<T>> T`	`getEnum(String name, T defaultValue)` Returns the account-specific enum value if it exists, then looks for an account-agnostic value.
`Trilean`	`getIsNamespaceEnabledAccount()`
`int`	`getListMaxResults()`
`long`	`getLong(String key, long defaultValue)` Returns the account-specific value if it exists, then looks for an account-agnostic value, and finally tries the default value.
`int`	`getMaxBackoffIntervalMilliseconds()`
`int`	`getMaxConcurrentReadThreads()`
`int`	`getMaxConcurrentWriteThreads()`
`int`	`getMaxIoRetries()`
`int`	`getMaxWriteRequestsToQueue()`
`int`	`getMinBackoffIntervalMilliseconds()`
`int`	`getNumLeaseThreads()`
`ExponentialRetryPolicy`	`getOauthTokenFetchRetryPolicy()`
`String`	`getPasswordString(String key)` Returns the account-specific password in string form if it exists, then looks for an account-agnostic value.
`org.apache.hadoop.security.ssl.DelegatingSSLSocketFactory.SSLChannelMode`	`getPreferredSSLFactoryOption()`
`org.apache.hadoop.conf.Configuration`	`getRawConfiguration()`
`int`	`getReadAheadBlockSize()`
`int`	`getReadAheadQueueDepth()`
`int`	`getReadBufferSize()`
`SASTokenProvider`	`getSASTokenProvider()`
`long`	`getSasTokenRenewPeriodForStreamsInSeconds()`
`boolean`	`getSkipUserGroupMetadataDuringInitialization()`
`String`	`getStorageAccountKey()`
`String`	`getString(String key, String defaultValue)` Returns the account-specific value if it exists, then looks for an account-agnostic value.
`AccessTokenProvider`	`getTokenProvider()`
`<U> Class<? extends U>`	`getTokenProviderClass(AuthType authType, String name, Class<? extends U> defaultValue, Class<U> xface)` Returns account-specific token provider class if it exists, else checks if an account-agnostic setting is present for token provider class if AuthType matches with authType passed.
`boolean`	`getTolerateOobAppends()`
`int`	`getWriteBufferSize()`
`int`	`getWriteMaxConcurrentRequestCount()`
`boolean`	`isAutoThrottlingEnabled()`
`boolean`	`isCheckAccessEnabled()`
`boolean`	`isConditionalCreateOverwriteEnabled()`
`boolean`	`isDelegationTokenManagerEnabled()`
`boolean`	`isEnabledMkdirOverwrite()`
`boolean`	`isFlushEnabled()`
`boolean`	`isHttpsAlwaysUsed()`
`boolean`	`isOutputStreamFlushDisabled()`
`boolean`	`isSecureMode()`
`boolean`	`isSmallWriteOptimizationEnabled()`
`boolean`	`isUpnUsed()`
`boolean`	`optimizeFooterRead()`
`boolean`	`readSmallFilesCompletely()`
`void`	`set(String key, String value)` Sets String in the underlying Configuration object.
`void`	`setBoolean(String key, boolean value)` Sets boolean in the underlying Configuration object.
`void`	`setEnableAbfsListIterator(boolean enableAbfsListIterator)`
`void`	`setMaxIoRetries(int maxIoRetries)`
`void`	`setOptimizeFooterRead(boolean optimizeFooterRead)`
`void`	`setReadSmallFilesCompletely(boolean readSmallFilesCompletely)`
`boolean`	`shouldReadBufferSizeAlways()`
`boolean`	`shouldTrackLatency()` Whether `AbfsClient` should track and send latency info back to storage servers.
`void`	`unset(String key)` Unsets parameter in the underlying Configuration object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - AbfsConfiguration
```
public AbfsConfiguration(org.apache.hadoop.conf.Configuration rawConfig,
 String accountName)
 throws IllegalAccessException,
 InvalidConfigurationValueException,
 IOException
```
 Throws:
 
 IllegalAccessException
 
 InvalidConfigurationValueException
 
 IOException
- Method Detail
 - getIsNamespaceEnabledAccount
```
public Trilean getIsNamespaceEnabledAccount()
```
 - getAccountName
```
public String getAccountName()
```
 Gets the Azure Storage account name corresponding to this instance of configuration.
 
 Returns:
 
 the Azure Storage account name
 - accountConf
```
public String accountConf(String key)
```
 Appends an account name to a configuration key yielding the account-specific form.
 
 Parameters:
 
 key - Account-agnostic configuration key
 
 Returns:
 
 Account-specific configuration key
 - get
```
public String get(String key)
```
 Returns the account-specific value if it exists, then looks for an account-agnostic value.
 
 Parameters:
 
 key - Account-agnostic configuration key
 
 Returns:
 
 value if one exists, else null
 - getString
```
public String getString(String key,
 String defaultValue)
```
 Returns the account-specific value if it exists, then looks for an account-agnostic value.
 
 Parameters:
 
 key - Account-agnostic configuration key
 
 Returns:
 
 value if one exists, else the default value
 - getBoolean
```
public boolean getBoolean(String key,
 boolean defaultValue)
```
 Returns the account-specific value if it exists, then looks for an account-agnostic value, and finally tries the default value.
 
 Parameters:
 
 key - Account-agnostic configuration key
 
 defaultValue - Value returned if none is configured
 
 Returns:
 
 value if one exists, else the default value
 - getLong
```
public long getLong(String key,
 long defaultValue)
```
 Returns the account-specific value if it exists, then looks for an account-agnostic value, and finally tries the default value.
 
 Parameters:
 
 key - Account-agnostic configuration key
 
 defaultValue - Value returned if none is configured
 
 Returns:
 
 value if one exists, else the default value
 - getPasswordString
```
public String getPasswordString(String key)
 throws IOException
```
 Returns the account-specific password in string form if it exists, then looks for an account-agnostic value.
 
 Parameters:
 
 key - Account-agnostic configuration key
 
 Returns:
 
 value in String form if one exists, else null
 
 Throws:
 
 IOException
 - getTokenProviderClass
```
public  Class<? extends U> getTokenProviderClass(AuthType authType,
 String name,
 Class<? extends U> defaultValue,
 Class xface)
```
 Returns account-specific token provider class if it exists, else checks if an account-agnostic setting is present for token provider class if AuthType matches with authType passed.
 
 Type Parameters:
 
 U - Interface class type
 
 Parameters:
 
 authType - AuthType effective on the account
 
 name - Account-agnostic configuration key
 
 defaultValue - Class returned if none is configured
 
 xface - Interface shared by all possible values
 
 Returns:
 
 Highest-precedence Class object that was found
 - getAccountSpecificClass
```
public  Class<? extends U> getAccountSpecificClass(String name,
 Class<? extends U> defaultValue,
 Class xface)
```
 Returns the account-specific class if it exists, else returns default value.
 
 Type Parameters:
 
 U - Interface class type
 
 Parameters:
 
 name - Account-agnostic configuration key
 
 defaultValue - Class returned if none is configured
 
 xface - Interface shared by all possible values
 
 Returns:
 
 Account specific Class object that was found
 - getAccountAgnosticClass
```
public  Class<? extends U> getAccountAgnosticClass(String name,
 Class<? extends U> defaultValue,
 Class xface)
```
 Returns account-agnostic Class if it exists, else returns the default value.
 
 Type Parameters:
 
 U - Interface class type
 
 Parameters:
 
 name - Account-agnostic configuration key
 
 defaultValue - Class returned if none is configured
 
 xface - Interface shared by all possible values
 
 Returns:
 
 Account-Agnostic Class object that was found
 - getEnum
```
public <T extends Enum<T>> T getEnum(String name,
 T defaultValue)
```
 Returns the account-specific enum value if it exists, then looks for an account-agnostic value.
 
 Type Parameters:
 
 T - Enum type
 
 Parameters:
 
 name - Account-agnostic configuration key
 
 defaultValue - Value returned if none is configured
 
 Returns:
 
 enum value if one exists, else null
 - getAccountAgnosticEnum
```
public <T extends Enum<T>> T getAccountAgnosticEnum(String name,
 T defaultValue)
```
 Returns the account-agnostic enum value if it exists, else return default.
 
 Type Parameters:
 
 T - Enum type
 
 Parameters:
 
 name - Account-agnostic configuration key
 
 defaultValue - Value returned if none is configured
 
 Returns:
 
 enum value if one exists, else null
 - unset
```
public void unset(String key)
```
 Unsets parameter in the underlying Configuration object. Provided only as a convenience; does not add any account logic.
 
 Parameters:
 
 key - Configuration key
 - set
```
public void set(String key,
 String value)
```
 Sets String in the underlying Configuration object. Provided only as a convenience; does not add any account logic.
 
 Parameters:
 
 key - Configuration key
 
 value - Configuration value
 - setBoolean
```
public void setBoolean(String key,
 boolean value)
```
 Sets boolean in the underlying Configuration object. Provided only as a convenience; does not add any account logic.
 
 Parameters:
 
 key - Configuration key
 
 value - Configuration value
 - isSecureMode
```
public boolean isSecureMode()
```
 - getStorageAccountKey
```
public String getStorageAccountKey()
 throws AzureBlobFileSystemException
```
 Throws:
 
 AzureBlobFileSystemException
 - getRawConfiguration
```
public org.apache.hadoop.conf.Configuration getRawConfiguration()
```
 - getWriteBufferSize
```
public int getWriteBufferSize()
```
 - isSmallWriteOptimizationEnabled
```
public boolean isSmallWriteOptimizationEnabled()
```
 - readSmallFilesCompletely
```
public boolean readSmallFilesCompletely()
```
 - optimizeFooterRead
```
public boolean optimizeFooterRead()
```
 - getReadBufferSize
```
public int getReadBufferSize()
```
 - getMinBackoffIntervalMilliseconds
```
public int getMinBackoffIntervalMilliseconds()
```
 - getMaxBackoffIntervalMilliseconds
```
public int getMaxBackoffIntervalMilliseconds()
```
 - getBackoffIntervalMilliseconds
```
public int getBackoffIntervalMilliseconds()
```
 - getMaxIoRetries
```
public int getMaxIoRetries()
```
 - getCustomTokenFetchRetryCount
```
public int getCustomTokenFetchRetryCount()
```
 - getAzureBlockSize
```
public long getAzureBlockSize()
```
 - isCheckAccessEnabled
```
public boolean isCheckAccessEnabled()
```
 - getSasTokenRenewPeriodForStreamsInSeconds
```
public long getSasTokenRenewPeriodForStreamsInSeconds()
```
 - getAzureBlockLocationHost
```
public String getAzureBlockLocationHost()
```
 - getMaxConcurrentWriteThreads
```
public int getMaxConcurrentWriteThreads()
```
 - getMaxConcurrentReadThreads
```
public int getMaxConcurrentReadThreads()
```
 - getListMaxResults
```
public int getListMaxResults()
```
 - getTolerateOobAppends
```
public boolean getTolerateOobAppends()
```
 - getAzureAtomicRenameDirs
```
public String getAzureAtomicRenameDirs()
```
 - isConditionalCreateOverwriteEnabled
```
public boolean isConditionalCreateOverwriteEnabled()
```
 - isEnabledMkdirOverwrite
```
public boolean isEnabledMkdirOverwrite()
```
 - getAppendBlobDirs
```
public String getAppendBlobDirs()
```
 - getAzureInfiniteLeaseDirs
```
public String getAzureInfiniteLeaseDirs()
```
 - getNumLeaseThreads
```
public int getNumLeaseThreads()
```
 - getCreateRemoteFileSystemDuringInitialization
```
public boolean getCreateRemoteFileSystemDuringInitialization()
```
 - getSkipUserGroupMetadataDuringInitialization
```
public boolean getSkipUserGroupMetadataDuringInitialization()
```
 - getReadAheadQueueDepth
```
public int getReadAheadQueueDepth()
```
 - getReadAheadBlockSize
```
public int getReadAheadBlockSize()
```
 - shouldReadBufferSizeAlways
```
public boolean shouldReadBufferSizeAlways()
```
 - isFlushEnabled
```
public boolean isFlushEnabled()
```
 - isOutputStreamFlushDisabled
```
public boolean isOutputStreamFlushDisabled()
```
 - isAutoThrottlingEnabled
```
public boolean isAutoThrottlingEnabled()
```
 - getCustomUserAgentPrefix
```
public String getCustomUserAgentPrefix()
```
 - getClusterName
```
public String getClusterName()
```
 - getClusterType
```
public String getClusterType()
```
 - getPreferredSSLFactoryOption
```
public org.apache.hadoop.security.ssl.DelegatingSSLSocketFactory.SSLChannelMode getPreferredSSLFactoryOption()
```
 - getAuthType
```
public AuthType getAuthType(String accountName)
```
 - isDelegationTokenManagerEnabled
```
public boolean isDelegationTokenManagerEnabled()
```
 - getDelegationTokenManager
```
public AbfsDelegationTokenManager getDelegationTokenManager()
 throws IOException
```
 Throws:
 
 IOException
 - isHttpsAlwaysUsed
```
public boolean isHttpsAlwaysUsed()
```
 - isUpnUsed
```
public boolean isUpnUsed()
```
 - shouldTrackLatency
```
public boolean shouldTrackLatency()
```
 Whether AbfsClient should track and send latency info back to storage servers.
 
 Returns:
 
 a boolean indicating whether latency should be tracked.
 - getTokenProvider
```
public AccessTokenProvider getTokenProvider()
 throws TokenAccessProviderException
```
 Throws:
 
 TokenAccessProviderException
 - getSASTokenProvider
```
public SASTokenProvider getSASTokenProvider()
 throws AzureBlobFileSystemException
```
 Throws:
 
 AzureBlobFileSystemException
 - getOauthTokenFetchRetryPolicy
```
public ExponentialRetryPolicy getOauthTokenFetchRetryPolicy()
```
 - getWriteMaxConcurrentRequestCount
```
public int getWriteMaxConcurrentRequestCount()
```
 - getMaxWriteRequestsToQueue
```
public int getMaxWriteRequestsToQueue()
```
 - enableAbfsListIterator
```
public boolean enableAbfsListIterator()
```
 - getClientProvidedEncryptionKey
```
public String getClientProvidedEncryptionKey()
```
 - setMaxIoRetries
```
public void setMaxIoRetries(int maxIoRetries)
```
 - setReadSmallFilesCompletely
```
public void setReadSmallFilesCompletely(boolean readSmallFilesCompletely)
```
 - setOptimizeFooterRead
```
public void setOptimizeFooterRead(boolean optimizeFooterRead)
```
 - setEnableAbfsListIterator
```
public void setEnableAbfsListIterator(boolean enableAbfsListIterator)
```

Class AbfsConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbfsConfiguration

Method Detail

getIsNamespaceEnabledAccount

getAccountName

accountConf

get

getString

getBoolean

getLong

getPasswordString

getTokenProviderClass

getAccountSpecificClass

getAccountAgnosticClass

getEnum

getAccountAgnosticEnum

unset

set

setBoolean

isSecureMode

getStorageAccountKey

getRawConfiguration

getWriteBufferSize

isSmallWriteOptimizationEnabled

readSmallFilesCompletely

optimizeFooterRead

getReadBufferSize

getMinBackoffIntervalMilliseconds

getMaxBackoffIntervalMilliseconds

getBackoffIntervalMilliseconds

getMaxIoRetries

getCustomTokenFetchRetryCount

getAzureBlockSize

isCheckAccessEnabled

getSasTokenRenewPeriodForStreamsInSeconds

getAzureBlockLocationHost

getMaxConcurrentWriteThreads

getMaxConcurrentReadThreads

getListMaxResults

getTolerateOobAppends

getAzureAtomicRenameDirs

isConditionalCreateOverwriteEnabled

isEnabledMkdirOverwrite

getAppendBlobDirs

getAzureInfiniteLeaseDirs

getNumLeaseThreads

getCreateRemoteFileSystemDuringInitialization

getSkipUserGroupMetadataDuringInitialization

getReadAheadQueueDepth

getReadAheadBlockSize

shouldReadBufferSizeAlways

isFlushEnabled

isOutputStreamFlushDisabled

isAutoThrottlingEnabled

getCustomUserAgentPrefix

getClusterName

getClusterType

getPreferredSSLFactoryOption

getAuthType

isDelegationTokenManagerEnabled

getDelegationTokenManager

isHttpsAlwaysUsed

isUpnUsed

shouldTrackLatency

getTokenProvider

getSASTokenProvider

getOauthTokenFetchRetryPolicy

getWriteMaxConcurrentRequestCount

getMaxWriteRequestsToQueue

enableAbfsListIterator

getClientProvidedEncryptionKey

setMaxIoRetries

setReadSmallFilesCompletely

setOptimizeFooterRead

setEnableAbfsListIterator