commit cc730a66f5f0784bd13005833267933827397fb3
author Jian Li <pyguni@gmail.com> Tue May 10 16:36:16 2016 -0700
committer Gerrit Code Review <gerrit@onlab.us> Wed May 11 04:34:59 2016 +0000
tree 20568051815fa5a2e82c056430209c4079ce7b9a
parent 5617994076a5f5a90e8b5354316e36b9420a50d3

Clean up source code of REST API

- Add missing @Produces annotation
- Correct comments
- Restrict variable access level

Change-Id: I7f75650b83651248370e7781b1e8aec7eac2314c

web/api/src/main/java/org/onosproject/rest/resources/ClusterWebResource.java

diff --git a/web/api/src/main/java/org/onosproject/rest/resources/ClusterWebResource.java b/web/api/src/main/java/org/onosproject/rest/resources/ClusterWebResource.java
index 3c07934..250fd02 100644
--- a/web/api/src/main/java/org/onosproject/rest/resources/ClusterWebResource.java
+++ b/web/api/src/main/java/org/onosproject/rest/resources/ClusterWebResource.java
@@ -28,6 +28,8 @@
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
 import java.io.IOException;
 import java.io.InputStream;
@@ -42,16 +44,17 @@
 @Path("cluster")
 public class ClusterWebResource extends AbstractWebResource {
 
-    public static final String NODE_NOT_FOUND = "Node is not found";
+    private static final String NODE_NOT_FOUND = "Node is not found";
 
     /**
      * Get all cluster nodes.
      * Returns array of all cluster nodes.
      *
-     * @return 200 OK
+     * @return 200 OK with a collection of cluster nodes
      * @onos.rsModel Cluster
      */
     @GET
+    @Produces(MediaType.APPLICATION_JSON)
     public Response getClusterNodes() {
         Iterable<ControllerNode> nodes = get(ClusterService.class).getNodes();
         return ok(encodeArray(ControllerNode.class, "nodes", nodes)).build();
@@ -62,11 +65,12 @@
      * Returns details of the specified cluster node.
      *
      * @param id cluster node identifier
-     * @return 200 OK
+     * @return 200 OK with a cluster node
      * @onos.rsModel ClusterNode
      */
     @GET
     @Path("{id}")
+    @Produces(MediaType.APPLICATION_JSON)
     public Response getClusterNode(@PathParam("id") String id) {
         ControllerNode node = nullIsNotFound(get(ClusterService.class).getNode(new NodeId(id)),
                                              NODE_NOT_FOUND);
@@ -84,6 +88,7 @@
      */
     @POST
     @Path("configuration")
+    @Produces(MediaType.APPLICATION_JSON)
     public Response formCluster(InputStream config) throws IOException {
         JsonCodec<ControllerNode> codec = codec(ControllerNode.class);
         ObjectNode root = (ObjectNode) mapper().readTree(config);
@@ -93,5 +98,4 @@
 
         return Response.ok().build();
     }
-
 }