Merge -r 1220809:1220810 from trunk to branch. FIXES: HDFS-2658

git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/branches/branch-0.23@1220814 13f79535-47bb-0310-9956-ffa450edef68
2011-12-19 15:56:57 +00:00 · 2011-12-19 15:56:57 +00:00 · f325906f2a
parent 1c45c96dc0
commit f325906f2a
7 changed files with 35 additions and 37 deletions
--- a/dev-support/test-patch.properties
+++ b/dev-support/test-patch.properties
@ -18,4 +18,4 @@

 OK_RELEASEAUDIT_WARNINGS=0
 OK_FINDBUGS_WARNINGS=0
-OK_JAVADOC_WARNINGS=6
+OK_JAVADOC_WARNINGS=8
--- a/hadoop-hdfs-project/dev-support/test-patch.properties
+++ b/hadoop-hdfs-project/dev-support/test-patch.properties
@ -18,4 +18,4 @@

 OK_RELEASEAUDIT_WARNINGS=0
 OK_FINDBUGS_WARNINGS=0
-OK_JAVADOC_WARNINGS=0
+OK_JAVADOC_WARNINGS=2
--- a/hadoop-hdfs-project/hadoop-hdfs-httpfs/src/main/java/org/apache/hadoop/fs/http/server/HttpFSParams.java
+++ b/hadoop-hdfs-project/hadoop-hdfs-httpfs/src/main/java/org/apache/hadoop/fs/http/server/HttpFSParams.java
@ -228,8 +228,6 @@ public FsPathParam(String path) {
     * <p/>
     * This is required because JAX-RS resolution of paths does not add
     * the root '/'.
-     *
-     * @returns absolute path.
     */
    public void makeAbsolute() {
      String path = value();
--- a/hadoop-hdfs-project/hadoop-hdfs-httpfs/src/main/java/org/apache/hadoop/fs/http/server/HttpFSServer.java
+++ b/hadoop-hdfs-project/hadoop-hdfs-httpfs/src/main/java/org/apache/hadoop/fs/http/server/HttpFSServer.java
@ -92,9 +92,9 @@ public class HttpFSServer {
   * Special binding for '/' as it is not handled by the wildcard binding.
   *
   * @param user principal making the request.
-   * @param op GET operation, default value is {@link HttpFSFileSystem.GetOpValues#OPEN}.
+   * @param op GET operation, default value is @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.GetOpValues#OPEN}.
   * @param filter Glob filter, default value is none. Used only if the
-   * operation is {@link HttpFSFileSystem.GetOpValues#LISTSTATUS}
+   * operation is @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.GetOpValues#LISTSTATUS}
   * @param doAs user being impersonated, defualt value is none. It can be used
   * only if the current user is a HttpFSServer proxyuser.
   *
@ -202,31 +202,31 @@ private FileSystem createFileSystem(Principal user, String doAs) throws IOExcept

  /**
   * Binding to handle all GET requests, supported operations are
-   * {@link HttpFSFileSystem.GetOpValues}.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.GetOpValues}.
   * <p/>
-   * The {@link HttpFSFileSystem.GetOpValues#INSTRUMENTATION} operation is available only
+   * The @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.GetOpValues#INSTRUMENTATION} operation is available only
   * to users that are in HttpFSServer's admin group (see {@link HttpFSServer}. It returns
   * HttpFSServer instrumentation data. The specified path must be '/'.
   *
   * @param user principal making the request.
   * @param path path for the GET request.
-   * @param op GET operation, default value is {@link HttpFSFileSystem.GetOpValues#OPEN}.
+   * @param op GET operation, default value is @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.GetOpValues#OPEN}.
   * @param offset of the  file being fetch, used only with
-   * {@link HttpFSFileSystem.GetOpValues#OPEN} operations.
-   * @param len amounts of bytes, used only with {@link HttpFSFileSystem.GetOpValues#OPEN}
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.GetOpValues#OPEN} operations.
+   * @param len amounts of bytes, used only with @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.GetOpValues#OPEN}
   * operations.
   * @param filter Glob filter, default value is none. Used only if the
-   * operation is {@link HttpFSFileSystem.GetOpValues#LISTSTATUS}
+   * operation is @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.GetOpValues#LISTSTATUS}
   * @param doAs user being impersonated, defualt value is none. It can be used
   * only if the current user is a HttpFSServer proxyuser.
   * @param override, default is true. Used only for
-   * {@link HttpFSFileSystem.PutOpValues#CREATE} operations.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#CREATE} operations.
   * @param blockSize block size to set, used only by
-   * {@link HttpFSFileSystem.PutOpValues#CREATE} operations.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#CREATE} operations.
   * @param permission permission to set, used only by
-   * {@link HttpFSFileSystem.PutOpValues#SETPERMISSION}.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#SETPERMISSION}.
   * @param replication replication factor to set, used only by
-   * {@link HttpFSFileSystem.PutOpValues#SETREPLICATION}.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#SETREPLICATION}.
   *
   * @return the request response.
   *
@ -361,7 +361,7 @@ protected URI createUploadRedirectionURL(UriInfo uriInfo, Enum<?> uploadOperatio
   *
   * @param user principal making the request.
   * @param path path for the DELETE request.
-   * @param op DELETE operation, default value is {@link HttpFSFileSystem.DeleteOpValues#DELETE}.
+   * @param op DELETE operation, default value is @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.DeleteOpValues#DELETE}.
   * @param recursive indicates if the delete is recursive, default is <code>false</code>
   * @param doAs user being impersonated, defualt value is none. It can be used
   * only if the current user is a HttpFSServer proxyuser.
@ -404,33 +404,33 @@ public Response delete(@Context Principal user,

  /**
   * Binding to handle all PUT requests, supported operations are
-   * {@link HttpFSFileSystem.PutOpValues}.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues}.
   *
   * @param is request input stream, used only for
-   * {@link HttpFSFileSystem.PostOpValues#APPEND} operations.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PostOpValues#APPEND} operations.
   * @param user principal making the request.
   * @param uriInfo the request uriInfo.
   * @param path path for the PUT request.
   * @param op PUT operation, no default value.
   * @param toPath new path, used only for
-   * {@link HttpFSFileSystem.PutOpValues#RENAME} operations.
-   * {@link HttpFSFileSystem.PutOpValues#SETTIMES}.
+   * {@link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#RENAME} operations.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#SETTIMES}.
   * @param owner owner to set, used only for
-   * {@link HttpFSFileSystem.PutOpValues#SETOWNER} operations.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#SETOWNER} operations.
   * @param group group to set, used only for
-   * {@link HttpFSFileSystem.PutOpValues#SETOWNER} operations.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#SETOWNER} operations.
   * @param override, default is true. Used only for
-   * {@link HttpFSFileSystem.PutOpValues#CREATE} operations.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#CREATE} operations.
   * @param blockSize block size to set, used only by
-   * {@link HttpFSFileSystem.PutOpValues#CREATE} operations.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#CREATE} operations.
   * @param permission permission to set, used only by
-   * {@link HttpFSFileSystem.PutOpValues#SETPERMISSION}.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#SETPERMISSION}.
   * @param replication replication factor to set, used only by
-   * {@link HttpFSFileSystem.PutOpValues#SETREPLICATION}.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#SETREPLICATION}.
   * @param modifiedTime modified time, in seconds since EPOC, used only by
-   * {@link HttpFSFileSystem.PutOpValues#SETTIMES}.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#SETTIMES}.
   * @param accessTime accessed time, in seconds since EPOC, used only by
-   * {@link HttpFSFileSystem.PutOpValues#SETTIMES}.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PutOpValues#SETTIMES}.
   * @param hasData indicates if the append request is uploading data or not
   * (just getting the handle).
   * @param doAs user being impersonated, defualt value is none. It can be used
@ -547,14 +547,14 @@ public Response put(InputStream is,

  /**
   * Binding to handle all OPST requests, supported operations are
-   * {@link HttpFSFileSystem.PostOpValues}.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PostOpValues}.
   *
   * @param is request input stream, used only for
-   * {@link HttpFSFileSystem.PostOpValues#APPEND} operations.
+   * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PostOpValues#APPEND} operations.
   * @param user principal making the request.
   * @param uriInfo the request uriInfo.
   * @param path path for the POST request.
-   * @param op POST operation, default is {@link HttpFSFileSystem.PostOpValues#APPEND}.
+   * @param op POST operation, default is @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.PostOpValues#APPEND}.
   * @param hasData indicates if the append request is uploading data or not (just getting the handle).
   * @param doAs user being impersonated, defualt value is none. It can be used
   * only if the current user is a HttpFSServer proxyuser.
--- a/hadoop-hdfs-project/hadoop-hdfs-httpfs/src/main/java/org/apache/hadoop/lib/lang/RunnableCallable.java
+++ b/hadoop-hdfs-project/hadoop-hdfs-httpfs/src/main/java/org/apache/hadoop/lib/lang/RunnableCallable.java
@ -68,9 +68,7 @@ public Void call() throws Exception {
  /**
   * Invokes the wrapped callable/runnable as a runnable.
   *
-   * @return void
-   *
-   * @throws Exception thrown by the wrapped callable/runnable invocation.
+   * @throws RuntimeException thrown by the wrapped callable/runnable invocation.
   */
  @Override
  public void run() {
--- a/hadoop-hdfs-project/hadoop-hdfs-httpfs/src/main/java/org/apache/hadoop/lib/server/Server.java
+++ b/hadoop-hdfs-project/hadoop-hdfs-httpfs/src/main/java/org/apache/hadoop/lib/server/Server.java
@ -251,7 +251,7 @@ public Status getStatus() {
   * The status must be settable.
   * <p/>
   * All services will be notified o the status change via the
-   * {@link Service#serverStatusChange(Status, Status)} method. If a service
+   * {@link Service#serverStatusChange(Server.Status, Server.Status)} method. If a service
   * throws an exception during the notification, the server will be destroyed.
   *
   * @param status status to set.
@ -703,7 +703,7 @@ public String getTempDir() {
  /**
   * Returns the server configuration.
   *
-   * @return
+   * @return the server configuration.
   */
  public Configuration getConfig() {
    return config;
--- a/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
+++ b/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
@ -110,6 +110,8 @@ Release 0.23.1 - UNRELEASED
    HDFS-2553. Fix BlockPoolSliceScanner spinning in a tight loop (Uma
    Maheswara Rao G via todd)

+    HDFS-2658. HttpFS introduced 70 javadoc warnings. (tucu)
+
 Release 0.23.0 - 2011-11-01 

  INCOMPATIBLE CHANGES