Fix spotbugs javadoc warnings in hadoop-azure module

[Copilot]

Description of PR

Addressed 18 spotbugs javadoc warnings across ABFS services and utilities. All public methods, constructors, and enum constants now have proper documentation.

Changes by component:

• ACL operations (AbfsAclHelper.java): Added javadoc for 7 public static methods handling ACL deserialization, serialization, modification, and removal operations
• HTTP operations (AbfsHttpOperation.java, AbfsAHCHttpOperation.java): Documented getResponseHeaders(), fixed main description for isConnectionDisconnectedOnError(), added constructor javadoc, replaced incorrect @inheritDoc with proper description for getRequestProperty()
• Metrics (AbfsBackoffMetrics.java, AbfsBackoffMetricsEnum.java): Added missing @param for constructor, documented 13 enum constants covering throttling, retry, and request metrics
• Client operations (AbfsClient.java, AbfsBlobClient.java): Added main description for getAbfsMetricsManager(), documented constructor and test helper methods
• Exceptions (AbfsApacheHttpExpect100Exception.java): Documented constructor

How was this patch tested?

Code review and syntax validation. No functional changes require testing.

For code changes:

• Does the title or this PR starts with the corresponding JIRA issue id (e.g. 'HADOOP-17799. Your PR title ...')?
• Object storage: have the integration tests been executed and the endpoint declared according to the connector-specific documentation?
• If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
• If applicable, have you updated the LICENSE, LICENSE-binary, NOTICE-binary files?

AI Tooling

If an AI tool was used:

• The PR includes the phrase "Contains content generated by GitHub Copilot"
• My use of AI contributions follows the ASF legal policy
  https://www.apache.org/legal/generative-tooling.html

Contains content generated by GitHub Copilot.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• repository.apache.org
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.12/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.12/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.12 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.12/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/AbfsHadoop/AbfsHadoop/hadoop-tools/hadoop-azure org.codehaus.plexus.classworlds.launcher.Launcher javadoc:javadoc -DskipTests (dns block)
• repository.jboss.org
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.12/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.12/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.12 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.12/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/AbfsHadoop/AbfsHadoop/hadoop-tools/hadoop-azure org.codehaus.plexus.classworlds.launcher.Launcher javadoc:javadoc -DskipTests (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

Create a new branch out of trunk and help me fix spotbug issues
Most of them are related to adding javadocs.

[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAclHelper.java:47: warning: no comment
[ERROR] public static Map<String, String> deserializeAclSpec(final String aclSpecString) throws AzureBlobFileSystemException {
[ERROR] ^
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAclHelper.java:189: warning: no comment
[ERROR] public static boolean isUpnFormatAclEntries(Map<String, String> aclEntries) {
[ERROR] ^
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAclHelper.java:145: warning: no comment
[ERROR] public static void modifyAclEntriesInternal(Map<String, String> aclEntries, Map<String, String> toModifyEntries)
[ERROR] ^
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAclHelper.java:73: warning: no comment
[ERROR] public static String processAclString(final String aclSpecString) {
[ERROR] ^
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAclHelper.java:95: warning: no comment
[ERROR] public static void removeAclEntriesInternal(Map<String, String> aclEntries, Map<String, String> toRemoveEntries)
[ERROR] ^
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAclHelper.java:62: warning: no comment
[ERROR] public static String serializeAclSpec(final Map<String, String> aclEntries) {
[ERROR] ^
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAclHelper.java:170: warning: no comment
[ERROR] public static void setAclEntriesInternal(Map<String, String> aclEntries, Map<String, String> getAclEntries)
[ERROR] ^
[ERROR] Generating /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/target/site/apidocs/org/apache/hadoop/fs/azurebfs/services/AbfsAdaptiveInputStream.html...
[ERROR] Generating /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/target/site/apidocs/org/apache/hadoop/fs/azurebfs/services/AbfsAHCHttpOperation.html...
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsHttpOperation.java:690: warning: no main description
[ERROR] * @return value of {@link #connectionDisconnectedOnError}
[ERROR] ^
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAHCHttpOperation.java:101: warning: no comment
[ERROR] public AbfsAHCHttpOperation(final URL url,
[ERROR] ^
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAHCHttpOperation.java:425: warning: @inheritdoc used but getRequestProperty(String) does not override or implement any method.
[ERROR] public String getRequestProperty(String name) {
[ERROR] ^
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsHttpOperation.java:238: warning: no comment
[ERROR] public abstract Map<String, List> getResponseHeaders();
[ERROR] ^
[ERROR] /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAHCHttpOperation.java:425: warning: @inheritdoc used but getRequestProperty(String) does not override or implement any method.
[ERROR] public String getRequestProperty(String name) {
[ERROR] ^
[ERROR] Generating /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-8212/ubuntu-focal/src/hadoop-tools/hadoop-azure/target/site/apidocs/org/apache/hadoop/fs/azurebfs/contracts/exceptions/AbfsApacheHttpExpect100Exception.html...
[ERROR] /home/jenkins/jenki...

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.