From de928a4aa03d199b48a678d62cf241edff3d0a66 Mon Sep 17 00:00:00 2001 From: Alejandro Abdelnur Date: Mon, 19 Dec 2011 15:53:53 +0000 Subject: [PATCH 1/2] HDFS-2658. HttpFS introduced 70 javadoc warnings. (tucu) git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/trunk@1220810 13f79535-47bb-0310-9956-ffa450edef68 --- dev-support/test-patch.properties | 2 +- .../dev-support/test-patch.properties | 2 +- .../hadoop/fs/http/server/HttpFSParams.java | 2 - .../hadoop/fs/http/server/HttpFSServer.java | 56 +++++++++---------- .../hadoop/lib/lang/RunnableCallable.java | 4 +- .../org/apache/hadoop/lib/server/Server.java | 4 +- hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt | 2 + 7 files changed, 35 insertions(+), 37 deletions(-) diff --git a/dev-support/test-patch.properties b/dev-support/test-patch.properties index 2f1a994ceb6..d5e950c9890 100644 --- 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 diff --git a/hadoop-hdfs-project/dev-support/test-patch.properties b/hadoop-hdfs-project/dev-support/test-patch.properties index 9365482b277..df85aa6e280 100644 --- 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 diff --git 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 index e24ebd54cfa..8e387f59f74 100644 --- 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 class HttpFSParams { *

* This is required because JAX-RS resolution of paths does not add * the root '/'. - * - * @returns absolute path. */ public void makeAbsolute() { String path = value(); diff --git 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 index aebaed8d1d6..43a0f07fd4e 100644 --- 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 @@ public class HttpFSServer { /** * Binding to handle all GET requests, supported operations are - * {@link HttpFSFileSystem.GetOpValues}. + * @link org.apache.hadoop.fs.http.client.HttpFSFileSystem.GetOpValues}. *

- * 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 @@ public class HttpFSServer { * * @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 false * @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 class HttpFSServer { /** * 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 class HttpFSServer { /** * 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. diff --git 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 index 319b414d4b3..c94947eb7f0 100644 --- 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 class RunnableCallable implements Callable, Runnable { /** * 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() { diff --git 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 index 22433240528..4db1e03a3f4 100644 --- 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 class Server { * The status must be settable. *

* 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 class Server { /** * Returns the server configuration. * - * @return + * @return the server configuration. */ public Configuration getConfig() { return config; diff --git a/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt b/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt index 0afd8f75d46..300d9fb4461 100644 --- a/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt +++ b/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt @@ -178,6 +178,8 @@ Trunk (unreleased changes) HDFS-2700. Fix failing TestDataNodeMultipleRegistrations in trunk (Uma Maheswara Rao G via todd) + HDFS-2658. HttpFS introduced 70 javadoc warnings. (tucu) + Release 0.23.1 - UNRELEASED INCOMPATIBLE CHANGES From dfba847eb65c14b4684f085f1b766b48604e4b66 Mon Sep 17 00:00:00 2001 From: Todd Lipcon Date: Mon, 19 Dec 2011 20:42:25 +0000 Subject: [PATCH 2/2] Amend HDFS-234 (bkjournal contrib). Fix findbugs build - Fixes pom parent to point to hadoop-project instead of hadoop-project-dist - Fix relative path in pom to have the correct number of ../s git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/trunk@1220940 13f79535-47bb-0310-9956-ffa450edef68 --- hadoop-hdfs-project/hadoop-hdfs/src/contrib/bkjournal/pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/hadoop-hdfs-project/hadoop-hdfs/src/contrib/bkjournal/pom.xml b/hadoop-hdfs-project/hadoop-hdfs/src/contrib/bkjournal/pom.xml index a0bafcffbb0..f908347f0a1 100644 --- a/hadoop-hdfs-project/hadoop-hdfs/src/contrib/bkjournal/pom.xml +++ b/hadoop-hdfs-project/hadoop-hdfs/src/contrib/bkjournal/pom.xml @@ -16,9 +16,9 @@ 4.0.0 org.apache.hadoop - hadoop-project-dist + hadoop-project 0.24.0-SNAPSHOT - ../../../../hadoop-project-dist + ../../../../../hadoop-project org.apache.hadoop.contrib