[HDFS-14228] Incorrect getSnapshottableDirListing() javadoc

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.1.0-beta
• Fix Version/s: 3.0.4, 3.1.2, 3.3.0, 3.2.1
• Component/s: snapshots
• Assignee: Dinesh Chitlangia
• Reporter: Wei-Chiu Chuang
• Created: 24/Jan/19 13:57
• Updated: 02/Oct/19 17:13
• Resolved: 25/Jan/19 15:39

Description

The Javadoc for DistributedFileSystem#getSnapshottableDirListing() is not consistent with FSNamesystem#getSnapshottableDirListing()

ClientProtocol#getSnapshottableDirListing()

/**
   * Get listing of all the snapshottable directories.
   *
   * @return Information about all the current snapshottable directory
   * @throws IOException If an I/O error occurred
   */
  @Idempotent
  @ReadOnly(isCoordinated = true)
  SnapshottableDirectoryStatus[] getSnapshottableDirListing()
      throws IOException;

DistributedFileSystem#getSnapshottableDirListing()

/**
   * @return All the snapshottable directories
   * @throws IOException
   */
  public SnapshottableDirectoryStatus[] getSnapshottableDirListing()

But the implementation at NameNode side is:

FSNamesystem#getSnapshottableDirListing()

/**
   * Get the list of snapshottable directories that are owned 
   * by the current user. Return all the snapshottable directories if the 
   * current user is a super user.
   * @return The list of all the current snapshottable directories
   * @throws IOException
   */
  public SnapshottableDirectoryStatus[] getSnapshottableDirListing()

That is, if this method is called by a non-super user, it does not return all snapshottable directories. File this jira to get this corrected to avoid confusion.