Skip to content

Commit 85f1a30

Browse files
committed
spotbugs
1 parent 09139dc commit 85f1a30

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AbfsConfiguration.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1565,7 +1565,7 @@ public AccessTokenProvider getTokenProvider() throws TokenAccessProviderExceptio
15651565
* the AbfsConfiguration with which a filesystem is initialized, and eliminate
15661566
* chances of dynamic modifications and spurious situations.<br>
15671567
* @return sasTokenProvider object based on configurations provided
1568-
* @throws AzureBlobFileSystemException
1568+
* @throws AzureBlobFileSystemException if SAS token provider initialization fails
15691569
*/
15701570
public SASTokenProvider getSASTokenProvider() throws AzureBlobFileSystemException {
15711571
AuthType authType = getEnum(FS_AZURE_ACCOUNT_AUTH_TYPE_PROPERTY_NAME, AuthType.SharedKey);
@@ -1613,13 +1613,15 @@ public SASTokenProvider getSASTokenProvider() throws AzureBlobFileSystemExceptio
16131613
}
16141614

16151615
/**
1616-
* Returns the SASTokenProvider implementation to be used to generate user-bound SAS token.<br>
1616+
* Returns the SASTokenProvider implementation to be used to generate user-bound SAS token.
16171617
* Custom implementation of {@link SASTokenProvider} under th config
1618-
* "fs.azure.sas.token.provider.type" needs to be provided.<br>
1618+
* "fs.azure.sas.token.provider.type" needs to be provided.
1619+
* @param authType authentication type
16191620
* @return sasTokenProvider object based on configurations provided
1620-
* @throws AzureBlobFileSystemException
1621+
* @throws AzureBlobFileSystemException is user-bound SAS token provider initialization fails
16211622
*/
1622-
public SASTokenProvider getUserBoundSASTokenProvider(AuthType authType) throws AzureBlobFileSystemException {
1623+
public SASTokenProvider getUserBoundSASTokenProvider(AuthType authType)
1624+
throws AzureBlobFileSystemException {
16231625

16241626
try {
16251627
Class<? extends SASTokenProvider> customSasTokenProviderImplementation =

hadoop-tools/hadoop-azure/src/site/markdown/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -798,8 +798,8 @@ requests. User can specify them as fixed SAS Token to be used across all the req
798798
- fs.azure.sas.fixed.token.ACCOUNT_NAME
799799
- fs.azure.sas.fixed.token
800800

801-
### User-bound user delegation SAS
802-
- **Description**: The user-bound SAS auth type allows to track the usage of the SAS token generated- something
801+
### User-bound user delegation SAS
802+
- **Description**: The user-bound SAS auth type allows to track the usage of the SAS token generated- something
803803
that was not possible in user-delegation SAS authentication type. Reach out to us at '[email protected]' for more information.
804804
To use this authentication type, both custom SAS token provider class (that implements org.apache.hadoop.fs.azurebfs.extensions.SASTokenProvider) as
805805
well as OAuth 2.0 provider type need to be specified.
@@ -809,9 +809,8 @@ requests. User can specify them as fixed SAS Token to be used across all the req
809809
- Custom token provider
810810
- Managed Identity
811811
- Workload Identity
812-
813-
Refer to respective OAuth 2.0 sections above to correctly chose the OAuth provider type
814812

813+
Refer to respective OAuth 2.0 sections above to correctly chose the OAuth provider type
815814

816815
- **Configuration**: To use this method with ABFS Driver, specify the following properties in your `core-site.xml` file:
817816

@@ -836,7 +835,6 @@ requests. User can specify them as fixed SAS Token to be used across all the req
836835
<value>CUSTOM_SAS_TOKEN_PROVIDER_CLASS</value>
837836
</property>
838837
```
839-
840838

841839
## <a name="technical"></a> Technical notes
842840

0 commit comments

Comments
 (0)