@Private
@Evolving
public class AbfsConfiguration
extends java.lang.Object
| Constructor | Description |
|---|---|
AbfsConfiguration(org.apache.hadoop.conf.Configuration rawConfig,
java.lang.String accountName) |
| Modifier and Type | Method | Description |
|---|---|---|
java.lang.String |
accountConf(java.lang.String key) |
Appends an account name to a configuration key yielding the
account-specific form.
|
boolean |
accountThrottlingEnabled() |
|
EncryptionContextProvider |
createEncryptionContextProvider() |
|
boolean |
enableAbfsListIterator() |
|
java.lang.String |
get(java.lang.String key) |
Returns the account-specific value if it exists, then looks for an
account-agnostic value.
|
<U> java.lang.Class<? extends U> |
getAccountAgnosticClass(java.lang.String name,
java.lang.Class<? extends U> defaultValue,
java.lang.Class<U> xface) |
Returns account-agnostic Class if it exists, else returns the default value.
|
<T extends java.lang.Enum<T>> |
getAccountAgnosticEnum(java.lang.String name,
T defaultValue) |
Returns the account-agnostic enum value if it exists, else
return default.
|
java.lang.String |
getAccountName() |
Gets the Azure Storage account name corresponding to this instance of configuration.
|
int |
getAccountOperationIdleTimeout() |
|
<U> java.lang.Class<? extends U> |
getAccountSpecificClass(java.lang.String name,
java.lang.Class<? extends U> defaultValue,
java.lang.Class<U> xface) |
Returns the account-specific class if it exists, else returns default value.
|
int |
getAnalysisPeriod() |
|
java.lang.String |
getAppendBlobDirs() |
|
AuthType |
getAuthType(java.lang.String accountName) |
|
java.lang.String |
getAzureAtomicRenameDirs() |
|
java.lang.String |
getAzureBlockLocationHost() |
|
long |
getAzureBlockSize() |
|
java.lang.String |
getAzureInfiniteLeaseDirs() |
|
int |
getBackoffIntervalMilliseconds() |
|
boolean |
getBoolean(java.lang.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.
|
java.lang.String |
getClientCorrelationId() |
Gets client correlation ID provided in config.
|
java.lang.String |
getClusterName() |
|
java.lang.String |
getClusterType() |
|
boolean |
getCreateRemoteFileSystemDuringInitialization() |
|
int |
getCustomTokenFetchRetryCount() |
|
java.lang.String |
getCustomUserAgentPrefix() |
|
AbfsDelegationTokenManager |
getDelegationTokenManager() |
|
java.lang.String |
getEncodedClientProvidedEncryptionKey() |
|
java.lang.String |
getEncodedClientProvidedEncryptionKeySHA() |
|
<T extends java.lang.Enum<T>> |
getEnum(java.lang.String name,
T defaultValue) |
Returns the account-specific enum value if it exists, then
looks for an account-agnostic value.
|
int |
getFooterReadBufferSize() |
|
int |
getHttpConnectionTimeout() |
|
int |
getHttpReadTimeout() |
|
int |
getInt(java.lang.String key,
int defaultValue) |
Returns the account-specific value if it exists, then looks for an
account-agnostic value, and finally tries the default value.
|
boolean |
getIsChecksumValidationEnabled() |
|
Trilean |
getIsNamespaceEnabledAccount() |
|
int |
getListMaxResults() |
|
long |
getLong(java.lang.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.
|
long |
getMaxApacheHttpClientConnectionIdleTime() |
|
int |
getMaxApacheHttpClientIoExceptionsRetries() |
|
int |
getMaxBackoffIntervalMilliseconds() |
|
int |
getMaxConcurrentReadThreads() |
|
int |
getMaxConcurrentWriteThreads() |
|
int |
getMaxIoRetries() |
|
int |
getMaxWriteRequestsToQueue() |
|
int |
getMinBackoffIntervalMilliseconds() |
|
int |
getNumLeaseThreads() |
|
ExponentialRetryPolicy |
getOauthTokenFetchRetryPolicy() |
|
java.lang.String |
getPasswordString(java.lang.String key) |
Returns the account-specific password in string form if it exists, then
looks for an account-agnostic value.
|
HttpOperationType |
getPreferredHttpOperationType() |
|
org.apache.hadoop.security.ssl.DelegatingSSLSocketFactory.SSLChannelMode |
getPreferredSSLFactoryOption() |
|
int |
getRateLimit() |
|
org.apache.hadoop.conf.Configuration |
getRawConfiguration() |
|
int |
getReadAheadBlockSize() |
|
int |
getReadAheadQueueDepth() |
|
int |
getReadAheadRange() |
|
int |
getReadBufferSize() |
|
boolean |
getRenameResilience() |
|
SASTokenProvider |
getSASTokenProvider() |
Returns the SASTokenProvider implementation to be used to generate SAS token.
Users can choose between a custom implementation of SASTokenProvider
or an in house implementation FixedSASTokenProvider.For Custom implementation "fs.azure.sas.token.provider.type" needs to be provided. For Fixed SAS Token use "fs.azure.sas.fixed.token" needs to be provided. In case both are provided, Preference will be given to Custom implementation. Avoid using a custom tokenProvider implementation just to read the configured fixed token, as this could create confusion. |
long |
getSasTokenRenewPeriodForStreamsInSeconds() |
|
boolean |
getSkipUserGroupMetadataDuringInitialization() |
|
boolean |
getStaticRetryForConnectionTimeoutEnabled() |
|
int |
getStaticRetryInterval() |
|
java.lang.String |
getStorageAccountKey() |
|
java.lang.String |
getString(java.lang.String key,
java.lang.String defaultValue) |
Returns the account-specific value if it exists, then looks for an
account-agnostic value.
|
AccessTokenProvider |
getTokenProvider() |
|
<U> java.lang.Class<? extends U> |
getTokenProviderClass(AuthType authType,
java.lang.String name,
java.lang.Class<? extends U> defaultValue,
java.lang.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() |
|
TracingHeaderFormat |
getTracingHeaderFormat() |
Enum config to allow user to pick format of x-ms-client-request-id header
|
int |
getWriteBufferSize() |
|
int |
getWriteMaxConcurrentRequestCount() |
|
boolean |
isAutoThrottlingEnabled() |
|
boolean |
isCheckAccessEnabled() |
|
boolean |
isConditionalCreateOverwriteEnabled() |
|
boolean |
isDelegationTokenManagerEnabled() |
|
boolean |
isEnabledMkdirOverwrite() |
|
boolean |
isExpectHeaderEnabled() |
|
boolean |
isFlushEnabled() |
|
boolean |
isHttpsAlwaysUsed() |
|
boolean |
isOutputStreamFlushDisabled() |
|
boolean |
isPaginatedDeleteEnabled() |
|
boolean |
isReadAheadEnabled() |
|
boolean |
isSecureMode() |
|
boolean |
isSmallWriteOptimizationEnabled() |
|
boolean |
isUpnUsed() |
|
boolean |
optimizeFooterRead() |
|
boolean |
readSmallFilesCompletely() |
|
void |
set(java.lang.String key,
java.lang.String value) |
Sets String in the underlying Configuration object.
|
void |
setBoolean(java.lang.String key,
boolean value) |
Sets boolean in the underlying Configuration object.
|
void |
setEnableAbfsListIterator(boolean enableAbfsListIterator) |
|
void |
setIsChecksumValidationEnabled(boolean isChecksumValidationEnabled) |
|
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(java.lang.String key) |
Unsets parameter in the underlying Configuration object.
|
public AbfsConfiguration(org.apache.hadoop.conf.Configuration rawConfig,
java.lang.String accountName)
throws java.lang.IllegalAccessException,
InvalidConfigurationValueException,
java.io.IOException
java.lang.IllegalAccessExceptionInvalidConfigurationValueExceptionjava.io.IOExceptionpublic Trilean getIsNamespaceEnabledAccount()
public java.lang.String getAccountName()
public java.lang.String getClientCorrelationId()
public java.lang.String accountConf(java.lang.String key)
key - Account-agnostic configuration keypublic java.lang.String get(java.lang.String key)
key - Account-agnostic configuration keypublic java.lang.String getString(java.lang.String key,
java.lang.String defaultValue)
key - Account-agnostic configuration keypublic boolean getBoolean(java.lang.String key,
boolean defaultValue)
key - Account-agnostic configuration keydefaultValue - Value returned if none is configuredpublic long getLong(java.lang.String key,
long defaultValue)
key - Account-agnostic configuration keydefaultValue - Value returned if none is configuredpublic int getInt(java.lang.String key,
int defaultValue)
key - Account-agnostic configuration keydefaultValue - Value returned if none is configuredpublic java.lang.String getPasswordString(java.lang.String key)
throws java.io.IOException
key - Account-agnostic configuration keyjava.io.IOExceptionpublic <U> java.lang.Class<? extends U> getTokenProviderClass(AuthType authType, java.lang.String name, java.lang.Class<? extends U> defaultValue, java.lang.Class<U> xface)
U - Interface class typeauthType - AuthType effective on the accountname - Account-agnostic configuration keydefaultValue - Class returned if none is configuredxface - Interface shared by all possible valuespublic <U> java.lang.Class<? extends U> getAccountSpecificClass(java.lang.String name,
java.lang.Class<? extends U> defaultValue,
java.lang.Class<U> xface)
U - Interface class typename - Account-agnostic configuration keydefaultValue - Class returned if none is configuredxface - Interface shared by all possible valuespublic <U> java.lang.Class<? extends U> getAccountAgnosticClass(java.lang.String name,
java.lang.Class<? extends U> defaultValue,
java.lang.Class<U> xface)
U - Interface class typename - Account-agnostic configuration keydefaultValue - Class returned if none is configuredxface - Interface shared by all possible valuespublic <T extends java.lang.Enum<T>> T getEnum(java.lang.String name,
T defaultValue)
T - Enum typename - Account-agnostic configuration keydefaultValue - Value returned if none is configuredpublic <T extends java.lang.Enum<T>> T getAccountAgnosticEnum(java.lang.String name,
T defaultValue)
T - Enum typename - Account-agnostic configuration keydefaultValue - Value returned if none is configuredpublic void unset(java.lang.String key)
key - Configuration keypublic void set(java.lang.String key,
java.lang.String value)
key - Configuration keyvalue - Configuration valuepublic void setBoolean(java.lang.String key,
boolean value)
key - Configuration keyvalue - Configuration valuepublic boolean isSecureMode()
public java.lang.String getStorageAccountKey()
throws AzureBlobFileSystemException
AzureBlobFileSystemExceptionpublic org.apache.hadoop.conf.Configuration getRawConfiguration()
public int getWriteBufferSize()
public boolean isSmallWriteOptimizationEnabled()
public boolean readSmallFilesCompletely()
public boolean optimizeFooterRead()
public int getFooterReadBufferSize()
public int getReadBufferSize()
public int getMinBackoffIntervalMilliseconds()
public int getMaxBackoffIntervalMilliseconds()
public boolean getStaticRetryForConnectionTimeoutEnabled()
public int getStaticRetryInterval()
public int getBackoffIntervalMilliseconds()
public int getMaxIoRetries()
public int getCustomTokenFetchRetryCount()
public int getHttpConnectionTimeout()
public int getHttpReadTimeout()
public long getAzureBlockSize()
public boolean isCheckAccessEnabled()
public long getSasTokenRenewPeriodForStreamsInSeconds()
public java.lang.String getAzureBlockLocationHost()
public int getMaxConcurrentWriteThreads()
public int getMaxConcurrentReadThreads()
public int getListMaxResults()
public boolean getTolerateOobAppends()
public java.lang.String getAzureAtomicRenameDirs()
public boolean isConditionalCreateOverwriteEnabled()
public boolean isEnabledMkdirOverwrite()
public java.lang.String getAppendBlobDirs()
public boolean isExpectHeaderEnabled()
public boolean accountThrottlingEnabled()
public java.lang.String getAzureInfiniteLeaseDirs()
public int getNumLeaseThreads()
public boolean getCreateRemoteFileSystemDuringInitialization()
public boolean getSkipUserGroupMetadataDuringInitialization()
public int getReadAheadQueueDepth()
public int getReadAheadBlockSize()
public boolean shouldReadBufferSizeAlways()
public boolean isFlushEnabled()
public boolean isOutputStreamFlushDisabled()
public boolean isAutoThrottlingEnabled()
public int getAccountOperationIdleTimeout()
public int getAnalysisPeriod()
public int getRateLimit()
public java.lang.String getCustomUserAgentPrefix()
public java.lang.String getClusterName()
public java.lang.String getClusterType()
public org.apache.hadoop.security.ssl.DelegatingSSLSocketFactory.SSLChannelMode getPreferredSSLFactoryOption()
public HttpOperationType getPreferredHttpOperationType()
public int getMaxApacheHttpClientIoExceptionsRetries()
public long getMaxApacheHttpClientConnectionIdleTime()
maxApacheHttpClientConnectionIdleTime.public TracingHeaderFormat getTracingHeaderFormat()
public AuthType getAuthType(java.lang.String accountName)
public boolean isDelegationTokenManagerEnabled()
public AbfsDelegationTokenManager getDelegationTokenManager() throws java.io.IOException
java.io.IOExceptionpublic boolean isHttpsAlwaysUsed()
public boolean isUpnUsed()
public boolean shouldTrackLatency()
AbfsClient should track and send latency info back to storage servers.public AccessTokenProvider getTokenProvider() throws TokenAccessProviderException
TokenAccessProviderExceptionpublic SASTokenProvider getSASTokenProvider() throws AzureBlobFileSystemException
SASTokenProvider
or an in house implementation FixedSASTokenProvider.AzureBlobFileSystemExceptionpublic EncryptionContextProvider createEncryptionContextProvider()
public boolean isReadAheadEnabled()
public int getReadAheadRange()
public ExponentialRetryPolicy getOauthTokenFetchRetryPolicy()
public int getWriteMaxConcurrentRequestCount()
public int getMaxWriteRequestsToQueue()
public boolean enableAbfsListIterator()
public java.lang.String getEncodedClientProvidedEncryptionKey()
public java.lang.String getEncodedClientProvidedEncryptionKeySHA()
@VisibleForTesting public void setMaxIoRetries(int maxIoRetries)
@VisibleForTesting public void setReadSmallFilesCompletely(boolean readSmallFilesCompletely)
@VisibleForTesting public void setOptimizeFooterRead(boolean optimizeFooterRead)
@VisibleForTesting public void setEnableAbfsListIterator(boolean enableAbfsListIterator)
public boolean getRenameResilience()
public boolean isPaginatedDeleteEnabled()
public boolean getIsChecksumValidationEnabled()
@VisibleForTesting public void setIsChecksumValidationEnabled(boolean isChecksumValidationEnabled)
Copyright © 2008–2025 Apache Software Foundation. All rights reserved.