github/sqoop
5
0
Fork 0
mirror of https://github.com/apache/sqoop.git synced 2025-05-04 20:11:54 +08:00
Code Issues Projects Releases Wiki Activity

SQOOP-899: Properly document REST endpoints in the server handler classes

Browse Source 
(Jarcec Cecho via Cheolsoo Park)
This commit is contained in:
Cheolsoo Park 2013-02-22 13:25:14 -08:00
parent 339069f322
commit cf95f19308
5 changed files with 36 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
server/src/main/java/org/apache/sqoop/handler/ConnectionRequestHandler.java
View File

@ -47,9 +47,6 @@
/**
* 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 @@
*
* 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 {

14
server/src/main/java/org/apache/sqoop/handler/ConnectorRequestHandler.java
View File

@ -34,6 +34,20 @@
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 =

5
server/src/main/java/org/apache/sqoop/handler/FrameworkRequestHandler.java
View File

@ -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.RequestHandler;
/**
* Framework request handler is supporting following resources:
*
* GET /v1/framework
* Get framework metadata.
*/
public class FrameworkRequestHandler implements RequestHandler {

9
server/src/main/java/org/apache/sqoop/handler/JobRequestHandler.java
View File

@ -47,9 +47,6 @@
/**
* 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 @@
*
* 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 {

7
server/src/main/java/org/apache/sqoop/handler/VersionRequestHandler.java
View File

@ -19,12 +19,17 @@
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 =