[HADOOP-13605] Clean up FileSystem javadocs, logging; improve diagnostics on FS load

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.8.0
• Fix Version/s: 2.9.0, 3.0.0-alpha2
• Component/s: fs
• Target Version/s: 2.9.0
• Hadoop Flags: Reviewed
• Assignee: Steve Loughran
• Reporter: Steve Loughran
• Created: 13/Sep/16 18:11
• Updated: 24/Nov/16 16:48
• Resolved: 24/Nov/16 01:20

Description

We can't easily debug FS instantiation problems as there isn't much detail in what was going on.

We can add more logging, but cannot simply switch FileSystem.LOG to SLF4J —the class is used in too many places, including tests which cast it. Instead, add a new private SLF4J Logger, LOGGER and switch logging to it.

While working in the base FileSystem class, take the opportunity to clean up javadocs and comments

1. add the list of exceptions, including indicating which base classes throw UnsupportedOperationExceptions
2. cut bits in the comments which are not true

The outcome of this patch is that IDEs shouldn't highlight most of the file as flawed in some way or another

Issue Links

• breaks: HADOOP-13833 TestSymlinkHdfsFileSystem#testCreateLinkUsingPartQualPath2 fails after HADOOP13605