Merge "creating a default subnet"

[controller.git] / opendaylight / northbound / hosttracker / src / main / java / org / opendaylight / controller / hosttracker / northbound / HostTrackerNorthbound.java

diff --git a/opendaylight/northbound/hosttracker/src/main/java/org/opendaylight/controller/hosttracker/northbound/HostTrackerNorthbound.java b/opendaylight/northbound/hosttracker/src/main/java/org/opendaylight/controller/hosttracker/northbound/HostTrackerNorthbound.java
index 836bfa2d60fdd59b62e14d8d8a2c2d9fd247e898..74c13d11f129943ba45e449411adfbc9f09d41e3 100644 (file)
--- a/opendaylight/northbound/hosttracker/src/main/java/org/opendaylight/controller/hosttracker/northbound/HostTrackerNorthbound.java
+++ b/opendaylight/northbound/hosttracker/src/main/java/org/opendaylight/controller/hosttracker/northbound/HostTrackerNorthbound.java
@@ -26,7 +26,6 @@ import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.SecurityContext;
 import javax.ws.rs.core.UriInfo;
-import javax.xml.bind.JAXBElement;
 
 import org.codehaus.enunciate.jaxrs.ResponseCode;
 import org.codehaus.enunciate.jaxrs.StatusCodes;
@@ -131,11 +130,10 @@ public class HostTrackerNorthbound {
      *
      * Example:
      *
-     * RequestURL:
-     *
+     * Request URL:
      * http://localhost:8080/controller/nb/v2/hosttracker/default/hosts/active
      *
-     * Response in XML
+     * Response body in XML
      *
      * <list>
      *  <hostConfig>
@@ -160,7 +158,7 @@ public class HostTrackerNorthbound {
      *  </hostConfig>
      * </list>
      *
-     * Response in JSON:
+     * Response body in JSON:
      *
      * {
      *  "hostConfig":[
@@ -218,11 +216,10 @@ public class HostTrackerNorthbound {
      *
      * Example:
      *
-     * RequestURL:
-     *
+     * Request URL:
      * http://localhost:8080/controller/nb/v2/hosttracker/default/hosts/inactive
      *
-     * Response in XML
+     * Response body in XML
      *
      * <list>
      *  <hostConfig>
@@ -247,7 +244,7 @@ public class HostTrackerNorthbound {
      *  </hostConfig>
      * </list>
      *
-     * Response in JSON:
+     * Response body in JSON:
      *
      * {
      *  "hostConfig":[
@@ -306,11 +303,10 @@ public class HostTrackerNorthbound {
      *
      * Example:
      *
-     * RequestURL:
-     *
+     * Request URL:
      * http://localhost:8080/controller/nb/v2/hosttracker/default/address/1.1.1.1
      *
-     * Response in XML
+     * Response body in XML
      *
      * <hostConfig>
      *  <dataLayerAddress>00:00:00:00:01:01</dataLayerAddress>
@@ -323,7 +319,7 @@ public class HostTrackerNorthbound {
      *  <staticHost>false</staticHost>
      * </hostConfig>
      *
-     * Response in JSON:
+     * Response body in JSON:
      *
      * {
      *  "dataLayerAddress":"00:00:00:00:01:01",
@@ -386,11 +382,10 @@ public class HostTrackerNorthbound {
      *
      * Example:
      *
-     * RequestURL:
-     *
+     * Request URL:
      * http://localhost:8080/controller/nb/v2/hosttracker/default/address/1.1.1.1
      *
-     * Request in XML
+     * Request body in XML
      *
      * <hostConfig>
      *  <dataLayerAddress>00:00:00:00:01:01</dataLayerAddress>
@@ -399,11 +394,11 @@ public class HostTrackerNorthbound {
      *  <nodeId>00:00:00:00:00:00:00:01</nodeId>
      *  <nodeConnectorType>OF</nodeConnectorType>
      *  <nodeConnectorId>9</nodeConnectorId>
-     *  <vlan>0</vlan>
-     *  <staticHost>false</staticHost>
+     *  <vlan>1</vlan>
+     *  <staticHost>true</staticHost>
      * </hostConfig>
      *
-     * Request in JSON:
+     * Request body in JSON:
      *
      * {
      *  "dataLayerAddress":"00:00:00:00:01:01",
@@ -411,8 +406,8 @@ public class HostTrackerNorthbound {
      *  "nodeId":"00:00:00:00:00:00:00:01",
      *  "nodeConnectorType":"OF",
      *  "nodeConnectorId":"9",
-     *  "vlan":"0",
-     *  "staticHost":"false",
+     *  "vlan":"1",
+     *  "staticHost":"true",
      *  "networkAddress":"1.1.1.1"
      * }
      * </pre>
@@ -472,6 +467,12 @@ public class HostTrackerNorthbound {
      * @param networkAddress
      *            IP Address
      * @return Response as dictated by the HTTP Response code.
+     *
+     * Example:
+     *
+     * Request URL:
+     * http://localhost:8080/controller/nb/v2/hosttracker/default/address/1.1.1.1
+     *
      */
 
     @Path("/{containerName}/address/{networkAddress}")