AbfsConfiguration (Apache Hadoop Azure support 3.2.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.
`String`	`get(String key)` Returns the account-specific value if it exists, then looks for an account-agnostic value.
`AbfsAuthorizer`	`getAbfsAuthorizer()`
`String`	`getAbfsExternalAuthorizationClass()`
`AuthType`	`getAuthType(String accountName)`
`String`	`getAzureAtomicRenameDirs()`
`String`	`getAzureBlockLocationHost()`
`long`	`getAzureBlockSize()`
`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.
`<U> Class<? extends U>`	`getClass(String name, Class<? extends U> defaultValue, Class<U> xface)` Returns the account-specific Class if it exists, then looks for an account-agnostic value, and finally tries the default value.
`boolean`	`getCreateRemoteFileSystemDuringInitialization()`
`String`	`getCustomUserAgentPrefix()`
`AbfsDelegationTokenManager`	`getDelegationTokenManager()`
`<T extends Enum<T>> T`	`getEnum(String name, T defaultValue)` Returns the account-specific password in string form if it exists, then looks for an account-agnostic value.
`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`	`getMinBackoffIntervalMilliseconds()`
`String`	`getPasswordString(String key)` Returns the account-specific password in string form if it exists, then looks for an account-agnostic value.
`SSLSocketFactoryEx.SSLChannelMode`	`getPreferredSSLFactoryOption()`
`org.apache.hadoop.conf.Configuration`	`getRawConfiguration()`
`int`	`getReadAheadQueueDepth()`
`int`	`getReadBufferSize()`
`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()`
`boolean`	`getTolerateOobAppends()`
`int`	`getWriteBufferSize()`
`boolean`	`isAutoThrottlingEnabled()`
`boolean`	`isDelegationTokenManagerEnabled()`
`boolean`	`isFlushEnabled()`
`boolean`	`isHttpsAlwaysUsed()`
`boolean`	`isSecureMode()`
`boolean`	`isUpnUsed()`
`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`	`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
  - 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
  - getClass
```
public <U> Class<? extends U> getClass(String name,
                                       Class<? extends U> defaultValue,
                                       Class<U> xface)
```
    Returns the account-specific Class if it exists, then looks for an account-agnostic value, and finally tries the default value.
    
    Parameters:
    
    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
  - getEnum
```
public <T extends Enum<T>> T getEnum(String name,
                                     T defaultValue)
```
    Returns the account-specific password in string form if it exists, then looks for an account-agnostic value.
    
    Parameters:
    
    name - Account-agnostic configuration key
    
    defaultValue - Value returned if none is configured
    
    Returns:
    
    value in String form 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()
```
  - getReadBufferSize
```
public int getReadBufferSize()
```
  - getMinBackoffIntervalMilliseconds
```
public int getMinBackoffIntervalMilliseconds()
```
  - getMaxBackoffIntervalMilliseconds
```
public int getMaxBackoffIntervalMilliseconds()
```
  - getBackoffIntervalMilliseconds
```
public int getBackoffIntervalMilliseconds()
```
  - getMaxIoRetries
```
public int getMaxIoRetries()
```
  - getAzureBlockSize
```
public long getAzureBlockSize()
```
  - getAzureBlockLocationHost
```
public String getAzureBlockLocationHost()
```
  - getMaxConcurrentWriteThreads
```
public int getMaxConcurrentWriteThreads()
```
  - getMaxConcurrentReadThreads
```
public int getMaxConcurrentReadThreads()
```
  - getTolerateOobAppends
```
public boolean getTolerateOobAppends()
```
  - getAzureAtomicRenameDirs
```
public String getAzureAtomicRenameDirs()
```
  - getCreateRemoteFileSystemDuringInitialization
```
public boolean getCreateRemoteFileSystemDuringInitialization()
```
  - getSkipUserGroupMetadataDuringInitialization
```
public boolean getSkipUserGroupMetadataDuringInitialization()
```
  - getReadAheadQueueDepth
```
public int getReadAheadQueueDepth()
```
  - isFlushEnabled
```
public boolean isFlushEnabled()
```
  - isAutoThrottlingEnabled
```
public boolean isAutoThrottlingEnabled()
```
  - getCustomUserAgentPrefix
```
public String getCustomUserAgentPrefix()
```
  - getPreferredSSLFactoryOption
```
public SSLSocketFactoryEx.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()
```
  - getTokenProvider
```
public AccessTokenProvider getTokenProvider()
                                     throws TokenAccessProviderException
```
    Throws:
    
    TokenAccessProviderException
  - getAbfsExternalAuthorizationClass
```
public String getAbfsExternalAuthorizationClass()
```
  - getAbfsAuthorizer
```
public AbfsAuthorizer getAbfsAuthorizer()
                                 throws IOException
```
    Throws:
    
    IOException

Class AbfsConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbfsConfiguration

Method Detail

accountConf

get

getString

getBoolean

getLong

getPasswordString

getClass

getEnum

unset

set

setBoolean

isSecureMode

getStorageAccountKey

getRawConfiguration

getWriteBufferSize

getReadBufferSize

getMinBackoffIntervalMilliseconds

getMaxBackoffIntervalMilliseconds

getBackoffIntervalMilliseconds

getMaxIoRetries

getAzureBlockSize

getAzureBlockLocationHost

getMaxConcurrentWriteThreads

getMaxConcurrentReadThreads

getTolerateOobAppends

getAzureAtomicRenameDirs

getCreateRemoteFileSystemDuringInitialization

getSkipUserGroupMetadataDuringInitialization

getReadAheadQueueDepth

isFlushEnabled

isAutoThrottlingEnabled

getCustomUserAgentPrefix

getPreferredSSLFactoryOption

getAuthType

isDelegationTokenManagerEnabled

getDelegationTokenManager

isHttpsAlwaysUsed

isUpnUsed

getTokenProvider

getAbfsExternalAuthorizationClass

getAbfsAuthorizer