Review Board 1.7.22


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

Review Request #9484 - Created Feb. 17, 2013 and submitted

Jarek Cecho
SQOOP-899
Reviewers
Sqoop
sqoop-sqoop2
I've updated the comments.
Tests seems to be passing.
server/src/main/java/org/apache/sqoop/handler/ConnectionRequestHandler.java
Revision 2d7419d6c8ac32c75ffb70841d9c0cf29ce2b392 New Change
[20] 44 lines
[+20]
45
import java.util.Locale;
45
import java.util.Locale;
46

    
   
46

   
47
/**
47
/**
48
 * Connection request handler is supporting following resources:
48
 * Connection request handler is supporting following resources:
49
 *
49
 *
50
 * GET /v1/connection

   
51
 * Get brief list of all connections present in the system.

   
52
 *

   
53
 * GET /v1/connection/:xid
50
 * GET /v1/connection/:xid
54
 * Return details about one particular connection with id :xid or about all of
51
 * Return details about one particular connection with id :xid or about all of
55
 * them if :xid equals to "all".
52
 * them if :xid equals to "all".
56
 *
53
 *
57
 * POST /v1/connection
54
 * POST /v1/connection
58
 * Create new connection
55
 * Create new connection
59
 *
56
 *
60
 * PUT /v1/connection/:xid
57
 * PUT /v1/connection/:xid
61
 * Update connection with id :xid.
58
 * Update connection with id :xid.
62
 *
59
 *
63
 * DELETE /v1/connection/:xid
60
 * DELETE /v1/connection/:xid
64
 * Remove connection with id :xid
61
 * Remove connection with id :xid

    
   
62
 *

    
   
63
 * Planned resources:

    
   
64
 *

    
   
65
 * GET /v1/connection

    
   
66
 * Get brief list of all connections present in the system.

    
   
67
 *
65
 */
68
 */
66
public class ConnectionRequestHandler implements RequestHandler {
69
public class ConnectionRequestHandler implements RequestHandler {
67

    
   
70

   
68
  private static final Logger LOG =
71
  private static final Logger LOG =
69
      Logger.getLogger(ConnectorRequestHandler.class);
72
      Logger.getLogger(ConnectorRequestHandler.class);
[+20] [20] 165 lines
server/src/main/java/org/apache/sqoop/handler/ConnectorRequestHandler.java
Revision 39b73e7fe2d5e305a25f5e145afba68399f59134 New Change
 
server/src/main/java/org/apache/sqoop/handler/FrameworkRequestHandler.java
Revision f635c35471ec0de36569476021edce6bfe11c87e New Change
 
server/src/main/java/org/apache/sqoop/handler/JobRequestHandler.java
Revision 41af6577e80d03b77a311f74d1a45558bbc66c20 New Change
 
server/src/main/java/org/apache/sqoop/handler/VersionRequestHandler.java
Revision a38e907e5b3b7e6b01b1caa562e4005e49c01b47 New Change
 
  1. server/src/main/java/org/apache/sqoop/handler/ConnectionRequestHandler.java: Loading...
  2. server/src/main/java/org/apache/sqoop/handler/ConnectorRequestHandler.java: Loading...
  3. server/src/main/java/org/apache/sqoop/handler/FrameworkRequestHandler.java: Loading...
  4. server/src/main/java/org/apache/sqoop/handler/JobRequestHandler.java: Loading...
  5. server/src/main/java/org/apache/sqoop/handler/VersionRequestHandler.java: Loading...