HADOOP-2470. Remove getContentLength(String), open(String, long, long)

and isDir(String) from ClientProtocol. ClientProtocol version changed
from 26 to 27. Contributed by Tsz Wo (Nicholas), SZE.



git-svn-id: https://svn.apache.org/repos/asf/hadoop/core/trunk@636967 13f79535-47bb-0310-9956-ffa450edef68

CHANGES.txt

@@ -30,6 +30,10 @@ Trunk (unreleased changes)
     specifies whether a recursive delete is intended.
     (Mahadev Konar via dhruba)
 
+    HADOOP-2470. Remove getContentLength(String), open(String, long, long)
+    and isDir(String) from ClientProtocol. ClientProtocol version changed
+    from 26 to 27. (Tsz Wo (Nicholas), SZE via cdouglas)
+
   NEW FEATURES
 
     HADOOP-1398.  Add HBase in-memory block cache.  (tomwhite)

src/java/org/apache/hadoop/dfs/ClientProtocol.java

@@ -36,44 +36,25 @@ interface ClientProtocol extends VersionedProtocol {
    * Compared to the previous version the following changes have been introduced:
    * (Only the latest change is reflected.
    * The log of historical changes can be retrieved from the svn).
-   * 25 : added {@link #getContentSummary(String path)}
-   * 26 : added delete(src, boolean) for recursive deletes on the namenode
+   * 27 : removed getContentLength(String), open(String, long, long) and isDir(String)
    */
-  public static final long versionID = 26L;
+  public static final long versionID = 27L;
   
   ///////////////////////////////////////
   // File contents
   ///////////////////////////////////////
   /**
-   * Open an existing file for read and get block locations within 
-   * the specified range. 
+   * Get locations of the blocks of the specified file within the specified range.
+   * DataNode locations for each block are sorted by
+   * the proximity to the client.
    * <p>
    * Return {@link LocatedBlocks} which contains
    * file length, blocks and their locations.
    * DataNode locations for each block are sorted by
    * the distance to the client's address.
    * <p>
-   * The client will then have to contact
-   * one of the indicated DataNodes to obtain the actual data.  There
-   * is no need to call close() or any other function after
-   * calling open().
-   * 
-   * @param src file name
-   * @param offset range start offset
-   * @param length range length
-   * @return file length and array of blocks with their locations
-   * @throws IOException
-   */
-  public LocatedBlocks open(String src, 
-                            long offset,
-                            long length) throws IOException;
-  
-  /**
-   * Get locations of the blocks of the specified file within the specified range.
-   * DataNode locations for each block are sorted by
-   * the proximity to the client.
-   * 
-   * @see #open(String, long, long)
+   * The client will then have to contact 
+   * one of the indicated DataNodes to obtain the actual data.
    * 
    * @param src file name
    * @param offset range start offset
@@ -255,11 +236,6 @@ interface ClientProtocol extends VersionedProtocol {
    */
   public boolean exists(String src) throws IOException;
 
-  /**
-   * Check whether the given filename is a directory or not.
-   */
-  public boolean isDir(String src) throws IOException;
-
   /**
    * Create a directory (or hierarchy of directories) with the given
    * name and permission.
@@ -446,16 +422,6 @@ interface ClientProtocol extends VersionedProtocol {
    */
   public DFSFileInfo getFileInfo(String src) throws IOException;
 
-  /**
-   * Get the total size of all files and directories rooted at
-   * the specified directory.
-   * @param src The string representation of the path
-   * @return size of directory subtree in bytes
-   * @deprecated use {@link #getContentSummary(String)}
-   */
-  @Deprecated
-  public long getContentLength(String src) throws IOException;
-
   /**
    * Get {@link ContentSummary} rooted at the specified directory.
    * @param path The string representation of the path

src/java/org/apache/hadoop/dfs/DFSClient.java

@@ -28,7 +28,6 @@ import org.apache.hadoop.net.NetUtils;
 import org.apache.hadoop.conf.*;
 import org.apache.hadoop.dfs.DistributedFileSystem.DiskStatus;
 import org.apache.hadoop.security.UnixUserGroupInformation;
-import org.apache.hadoop.security.UserGroupInformation;
 import org.apache.hadoop.util.*;
 
 import org.apache.commons.logging.*;
@@ -461,11 +460,14 @@ class DFSClient implements FSConstants {
     return namenode.exists(src);
   }
 
-  /**
-   */
+  /** @deprecated Use getFileStatus() instead */
+  @Deprecated
   public boolean isDirectory(String src) throws IOException {
-    checkOpen();
-    return namenode.isDir(src);
+    try {
+      return getFileInfo(src).isDir();
+    } catch (FileNotFoundException e) {
+      return false;               // f does not exist
+    }
   }
 
   /**
@@ -578,21 +580,6 @@ class DFSClient implements FSConstants {
     return namenode.mkdirs(src, masked);
   }
 
-  /**
-   * Retrieves the total size of all files and directories under
-   * the specified path.
-   * 
-   * @param src
-   * @throws IOException
-   * @return the number of bytes in the subtree rooted at src
-   * @deprecated use {@link #getContentSummary(String)}
-   */
-  @Deprecated
-  public long getContentLength(String src
-                               ) throws IOException {
-    return getContentSummary(src).getLength();
-  }
-  
   ContentSummary getContentSummary(String src) throws IOException {
     return namenode.getContentSummary(src);
   }
@@ -1005,7 +992,10 @@ class DFSClient implements FSConstants {
      * Grab the open-file info from namenode
      */
     synchronized void openInfo() throws IOException {
-      LocatedBlocks newInfo = namenode.open(src, 0, prefetchSize);
+      LocatedBlocks newInfo = namenode.getBlockLocations(src, 0, prefetchSize);
+      if (newInfo == null) {
+        throw new IOException("Cannot open filename " + src);
+      }
 
       if (locatedBlocks != null) {
         Iterator<LocatedBlock> oldIter = locatedBlocks.getLocatedBlocks().iterator();

src/java/org/apache/hadoop/dfs/FSNamesystem.java

@@ -786,8 +786,6 @@ class FSNamesystem implements FSConstants, FSNamesystemMBean {
 
   /**
    * Get block locations within the specified range.
-   * 
-   * @see ClientProtocol#open(String, long, long)
    * @see ClientProtocol#getBlockLocations(String, long, long)
    */
   LocatedBlocks getBlockLocations(String src, long offset, long length
@@ -1468,7 +1466,7 @@ class FSNamesystem implements FSConstants, FSNamesystemMBean {
    * is a directory (non empty) and recursive is set to false then throw exception.
    */
     public boolean delete(String src, boolean recursive) throws IOException {
-      if (isDir(src) && (!recursive) && (!dir.isDirEmpty(src))) {
+      if ((!recursive) && (!dir.isDirEmpty(src))) {
         throw new IOException(src + " is non empty");
       }
       boolean status = deleteInternal(src, true, true);
@@ -1529,16 +1527,6 @@ class FSNamesystem implements FSConstants, FSNamesystemMBean {
     return dir.exists(src);
   }
 
-  /**
-   * Whether the given name is a directory
-   */
-  public boolean isDir(String src) throws AccessControlException {
-    if (isPermissionEnabled) {
-      checkTraverse(src);
-    }
-    return dir.isDir(src);
-  }
-
   /** Get the file info for a specific file.
    * @param src The string representation of the path to the file
    * @throws IOException if file does not exist

src/java/org/apache/hadoop/dfs/NameNode.java

@@ -233,25 +233,11 @@ public class NameNode implements ClientProtocol, DatanodeProtocol,
   /////////////////////////////////////////////////////
   // ClientProtocol
   /////////////////////////////////////////////////////
-    
-  /**
-   */
-  public LocatedBlocks open(String src,
-                            long offset,
-                            long length) throws IOException {
-    LocatedBlocks result = getBlockLocations(src, offset, length);
-    if (result == null) {
-      throw new IOException("Cannot open filename " + src);
-    }
-    myMetrics.numFilesOpened.inc();
-    return result;
-  }
-
-  /**
-   */
+  /** {@inheritDoc} */
   public LocatedBlocks   getBlockLocations(String src, 
                                           long offset, 
                                           long length) throws IOException {
+    myMetrics.numGetBlockLocations.inc();
     return namesystem.getBlockLocations(getClientMachine(), 
                                         src, offset, length);
   }
@@ -401,12 +387,6 @@ public class NameNode implements ClientProtocol, DatanodeProtocol,
     return namesystem.exists(src);
   }
 
-  /**
-   */
-  public boolean isDir(String src) throws IOException {
-    return namesystem.isDir(src);
-  }
-
   /**
    * Check path length does not exceed maximum.  Returns true if
    * length and depth are okay.  Returns false if length is too long 
@@ -532,12 +512,6 @@ public class NameNode implements ClientProtocol, DatanodeProtocol,
     namesystem.metaSave(filename);
   }
 
-  /** {@inheritDoc} */
-  @Deprecated
-  public long getContentLength(String src)  throws IOException {
-    return getContentSummary(src).getLength();
-  }
-
   /** {@inheritDoc} */
   public ContentSummary getContentSummary(String path) throws IOException {
     return namesystem.getContentSummary(path);

src/java/org/apache/hadoop/dfs/NameNodeMetrics.java

@@ -46,7 +46,7 @@ public class NameNodeMetrics implements Updater {
     private NameNodeStatistics namenodeStats;
     
     public MetricsTimeVaryingInt numFilesCreated = new MetricsTimeVaryingInt("FilesCreated");
-    public MetricsTimeVaryingInt numFilesOpened = new MetricsTimeVaryingInt("FilesOpened");
+    public MetricsTimeVaryingInt numGetBlockLocations = new MetricsTimeVaryingInt("GetBlockLocations");
     public MetricsTimeVaryingInt numFilesRenamed = new MetricsTimeVaryingInt("FilesRenamed");
     public MetricsTimeVaryingInt numFilesListed = new MetricsTimeVaryingInt("FilesListed");
 
@@ -91,7 +91,7 @@ public class NameNodeMetrics implements Updater {
     public void doUpdates(MetricsContext unused) {
       synchronized (this) {
         numFilesCreated.pushMetric(metricsRecord);
-        numFilesOpened.pushMetric(metricsRecord);
+        numGetBlockLocations.pushMetric(metricsRecord);
         numFilesRenamed.pushMetric(metricsRecord);
         numFilesListed.pushMetric(metricsRecord);
 

src/java/org/apache/hadoop/dfs/namenode/metrics/NameNodeStatistics.java

@@ -170,11 +170,9 @@ public class NameNodeStatistics implements NameNodeStatisticsMBean {
     return myMetrics.numFilesListed.getPreviousIntervalValue();
   }
 
-  /**
-   * @inheritDoc
-   */
-  public int getNumFilesOpened() {
-    return myMetrics.numFilesOpened.getPreviousIntervalValue();
+  /** @inheritDoc */
+  public int getNumGetBlockLocations() {
+    return myMetrics.numGetBlockLocations.getPreviousIntervalValue();
   }
 
   /**

src/java/org/apache/hadoop/dfs/namenode/metrics/NameNodeStatisticsMBean.java

@@ -141,11 +141,12 @@ public interface NameNodeStatisticsMBean {
   int getNumFilesCreated();
   
   /**
-   *   Number of files opened for reading in the last interval
+   * Number of
+   * {@link org.apache.hadoop.dfs.NameNode#getBlockLocations(String,long,long)}
    * @return  number of operations
    */
-  int getNumFilesOpened();
-  
+  int getNumGetBlockLocations();
+
   /**
    *   Number of files renamed in the last interval
    * @return number of operations

src/test/org/apache/hadoop/dfs/NNThroughputBenchmark.java

@@ -526,7 +526,7 @@ public class NNThroughputBenchmark implements FSConstants {
     long executeOp(int daemonId, int inputIdx, String ignore) 
     throws IOException {
       long start = System.currentTimeMillis();
-      nameNode.open(fileNames[daemonId][inputIdx], 0L, BLOCK_SIZE);
+      nameNode.getBlockLocations(fileNames[daemonId][inputIdx], 0L, BLOCK_SIZE);
       long end = System.currentTimeMillis();
       return end-start;
     }