You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sqoop.apache.org by ch...@apache.org on 2013/02/22 22:31:03 UTC
[1/3] git commit: SQOOP-899: Properly document REST endpoints in the
server handler classes
SQOOP-899: Properly document REST endpoints in the server handler classes
(Jarcec Cecho via Cheolsoo Park)
Project: http://git-wip-us.apache.org/repos/asf/sqoop/repo
Commit: http://git-wip-us.apache.org/repos/asf/sqoop/commit/cf95f193
Tree: http://git-wip-us.apache.org/repos/asf/sqoop/tree/cf95f193
Diff: http://git-wip-us.apache.org/repos/asf/sqoop/diff/cf95f193
Branch: refs/heads/sqoop2
Commit: cf95f19308fd308424dfa88cd9df7a2b33168b15
Parents: 339069f
Author: Cheolsoo Park <ch...@apache.org>
Authored: Fri Feb 22 13:25:14 2013 -0800
Committer: Cheolsoo Park <ch...@apache.org>
Committed: Fri Feb 22 13:25:14 2013 -0800
----------------------------------------------------------------------
.../sqoop/handler/ConnectionRequestHandler.java | 9 ++++++---
.../sqoop/handler/ConnectorRequestHandler.java | 14 ++++++++++++++
.../sqoop/handler/FrameworkRequestHandler.java | 5 ++++-
.../apache/sqoop/handler/JobRequestHandler.java | 9 ++++++---
.../sqoop/handler/VersionRequestHandler.java | 7 ++++++-
5 files changed, 36 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/sqoop/blob/cf95f193/server/src/main/java/org/apache/sqoop/handler/ConnectionRequestHandler.java
----------------------------------------------------------------------
diff --git a/server/src/main/java/org/apache/sqoop/handler/ConnectionRequestHandler.java b/server/src/main/java/org/apache/sqoop/handler/ConnectionRequestHandler.java
index 2d7419d..7842e32 100644
--- a/server/src/main/java/org/apache/sqoop/handler/ConnectionRequestHandler.java
+++ b/server/src/main/java/org/apache/sqoop/handler/ConnectionRequestHandler.java
@@ -47,9 +47,6 @@ import java.util.Locale;
/**
* Connection request handler is supporting following resources:
*
- * GET /v1/connection
- * Get brief list of all connections present in the system.
- *
* GET /v1/connection/:xid
* Return details about one particular connection with id :xid or about all of
* them if :xid equals to "all".
@@ -62,6 +59,12 @@ import java.util.Locale;
*
* DELETE /v1/connection/:xid
* Remove connection with id :xid
+ *
+ * Planned resources:
+ *
+ * GET /v1/connection
+ * Get brief list of all connections present in the system.
+ *
*/
public class ConnectionRequestHandler implements RequestHandler {
http://git-wip-us.apache.org/repos/asf/sqoop/blob/cf95f193/server/src/main/java/org/apache/sqoop/handler/ConnectorRequestHandler.java
----------------------------------------------------------------------
diff --git a/server/src/main/java/org/apache/sqoop/handler/ConnectorRequestHandler.java b/server/src/main/java/org/apache/sqoop/handler/ConnectorRequestHandler.java
index 39b73e7..4c389cc 100644
--- a/server/src/main/java/org/apache/sqoop/handler/ConnectorRequestHandler.java
+++ b/server/src/main/java/org/apache/sqoop/handler/ConnectorRequestHandler.java
@@ -34,6 +34,20 @@ import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
+/**
+ * Connector request handler is supporting following resources:
+ *
+ * GET /v1/connector/:cid
+ * Return details about one particular connector with id :cid or about all of
+ * them if :cid equals to "all".
+ *
+ * Planned resources:
+ *
+ * GET /v1/connector
+ * Get brief list of all connectors present in the system. This resource is not
+ * yet implemented.
+ *
+ */
public class ConnectorRequestHandler implements RequestHandler {
private static final Logger LOG =
http://git-wip-us.apache.org/repos/asf/sqoop/blob/cf95f193/server/src/main/java/org/apache/sqoop/handler/FrameworkRequestHandler.java
----------------------------------------------------------------------
diff --git a/server/src/main/java/org/apache/sqoop/handler/FrameworkRequestHandler.java b/server/src/main/java/org/apache/sqoop/handler/FrameworkRequestHandler.java
index f635c35..48fe0ff 100644
--- a/server/src/main/java/org/apache/sqoop/handler/FrameworkRequestHandler.java
+++ b/server/src/main/java/org/apache/sqoop/handler/FrameworkRequestHandler.java
@@ -18,7 +18,7 @@
package org.apache.sqoop.handler;
import org.apache.log4j.Logger;
-import org.apache.sqoop.common.SqoopException;
+
import org.apache.sqoop.framework.FrameworkManager;
import org.apache.sqoop.json.FrameworkBean;
import org.apache.sqoop.json.JsonBean;
@@ -26,7 +26,10 @@ import org.apache.sqoop.server.RequestContext;
import org.apache.sqoop.server.RequestHandler;
/**
+ * Framework request handler is supporting following resources:
*
+ * GET /v1/framework
+ * Get framework metadata.
*/
public class FrameworkRequestHandler implements RequestHandler {
http://git-wip-us.apache.org/repos/asf/sqoop/blob/cf95f193/server/src/main/java/org/apache/sqoop/handler/JobRequestHandler.java
----------------------------------------------------------------------
diff --git a/server/src/main/java/org/apache/sqoop/handler/JobRequestHandler.java b/server/src/main/java/org/apache/sqoop/handler/JobRequestHandler.java
index 41af657..18b9997 100644
--- a/server/src/main/java/org/apache/sqoop/handler/JobRequestHandler.java
+++ b/server/src/main/java/org/apache/sqoop/handler/JobRequestHandler.java
@@ -47,9 +47,6 @@ import java.util.Locale;
/**
* Job request handler is supporting following resources:
*
- * GET /v1/job
- * Get brief list of all jobs present in the system.
- *
* GET /v1/job/:jid
* Return details about one particular job with id :jid or about all of
* them if :jid equals to "all".
@@ -62,6 +59,12 @@ import java.util.Locale;
*
* DELETE /v1/job/:jid
* Remove job with id :jid
+ *
+ * Planned resources:
+ *
+ * GET /v1/job
+ * Get brief list of all jobs present in the system. This resource is not yet
+ * implemented.
*/
public class JobRequestHandler implements RequestHandler {
http://git-wip-us.apache.org/repos/asf/sqoop/blob/cf95f193/server/src/main/java/org/apache/sqoop/handler/VersionRequestHandler.java
----------------------------------------------------------------------
diff --git a/server/src/main/java/org/apache/sqoop/handler/VersionRequestHandler.java b/server/src/main/java/org/apache/sqoop/handler/VersionRequestHandler.java
index a38e907..f92d107 100644
--- a/server/src/main/java/org/apache/sqoop/handler/VersionRequestHandler.java
+++ b/server/src/main/java/org/apache/sqoop/handler/VersionRequestHandler.java
@@ -19,12 +19,17 @@ package org.apache.sqoop.handler;
import org.apache.log4j.Logger;
import org.apache.sqoop.common.VersionInfo;
-import org.apache.sqoop.common.SqoopException;
import org.apache.sqoop.json.JsonBean;
import org.apache.sqoop.json.VersionBean;
import org.apache.sqoop.server.RequestContext;
import org.apache.sqoop.server.RequestHandler;
+/**
+ * Version request handler is supporting following resources:
+ *
+ * GET /version
+ * Get server version and supported protocol versions.
+ */
public class VersionRequestHandler implements RequestHandler {
private static final Logger LOG =