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 91185bb40573eea09b8e26c5aeb596e32eb23ab4..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;
@@ -62,11 +61,7 @@ import org.opendaylight.controller.switchmanager.ISwitchManager;
  * Authentication realm : <b>opendaylight</b><br>
  * Transport : <b>HTTP and HTTPS</b><br>
  * <br>
- * HTTPS Authentication is disabled by default. Administrator can enable it in
- * tomcat-server.xml after adding a proper keystore / SSL certificate from a
- * trusted authority.<br>
- * More info :
- * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
+ * HTTPS Authentication is disabled by default.
  *
  */
 
@@ -135,11 +130,10 @@ public class HostTrackerNorthbound {
      *
      * Example:
      *
-     * RequestURL:
+     * Request URL:
+     * http://localhost:8080/controller/nb/v2/hosttracker/default/hosts/active
      *
-     * http://localhost:8080/controller/nb/v2/host/default
-     *
-     * Response in XML
+     * Response body in XML
      *
      * &lt;list&gt;
      * &#x20;&lt;hostConfig&gt;
@@ -164,7 +158,7 @@ public class HostTrackerNorthbound {
      * &#x20;&lt;/hostConfig&gt;
      * &lt;/list&gt;
      *
-     * Response in JSON:
+     * Response body in JSON:
      *
      * {
      * &#x20;"hostConfig":[
@@ -192,7 +186,7 @@ public class HostTrackerNorthbound {
      * }
      * </pre>
      */
-    @Path("/{containerName}")
+    @Path("/{containerName}/hosts/active")
     @GET
     @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
     @TypeHint(Hosts.class)
@@ -222,11 +216,10 @@ public class HostTrackerNorthbound {
      *
      * Example:
      *
-     * RequestURL:
-     *
-     * http://localhost:8080/controller/nb/v2/host/default/inactive
+     * Request URL:
+     * http://localhost:8080/controller/nb/v2/hosttracker/default/hosts/inactive
      *
-     * Response in XML
+     * Response body in XML
      *
      * &lt;list&gt;
      * &#x20;&lt;hostConfig&gt;
@@ -251,7 +244,7 @@ public class HostTrackerNorthbound {
      * &#x20;&lt;/hostConfig&gt;
      * &lt;/list&gt;
      *
-     * Response in JSON:
+     * Response body in JSON:
      *
      * {
      * &#x20;"hostConfig":[
@@ -279,7 +272,7 @@ public class HostTrackerNorthbound {
      * }
      * </pre>
      */
-    @Path("/{containerName}/inactive")
+    @Path("/{containerName}/hosts/inactive")
     @GET
     @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
     @TypeHint(Hosts.class)
@@ -310,11 +303,10 @@ public class HostTrackerNorthbound {
      *
      * Example:
      *
-     * RequestURL:
-     *
-     * http://localhost:8080/controller/nb/v2/host/default/1.1.1.1
+     * Request URL:
+     * http://localhost:8080/controller/nb/v2/hosttracker/default/address/1.1.1.1
      *
-     * Response in XML
+     * Response body in XML
      *
      * &lt;hostConfig&gt;
      * &#x20;&lt;dataLayerAddress&gt;00:00:00:00:01:01&lt;/dataLayerAddress&gt;
@@ -327,7 +319,7 @@ public class HostTrackerNorthbound {
      * &#x20;&lt;staticHost&gt;false&lt;/staticHost&gt;
      * &lt;/hostConfig&gt;
      *
-     * Response in JSON:
+     * Response body in JSON:
      *
      * {
      * &#x20;"dataLayerAddress":"00:00:00:00:01:01",
@@ -341,7 +333,7 @@ public class HostTrackerNorthbound {
      * }
      * </pre>
      */
-    @Path("/{containerName}/{networkAddress}")
+    @Path("/{containerName}/address/{networkAddress}")
     @GET
     @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
     @TypeHint(HostConfig.class)
@@ -374,7 +366,8 @@ public class HostTrackerNorthbound {
     }
 
     /**
-     * Add a Static Host configuration
+     * Add a Static Host configuration. If a host by the given address already
+     * exists, this method will respond with a non-successful status response.
      *
      * @param containerName
      *            Name of the Container. The Container name for the base
@@ -389,11 +382,10 @@ public class HostTrackerNorthbound {
      *
      * Example:
      *
-     * RequestURL:
+     * Request URL:
+     * http://localhost:8080/controller/nb/v2/hosttracker/default/address/1.1.1.1
      *
-     * http://localhost:8080/controller/nb/v2/host/default/1.1.1.1
-     *
-     * Request in XML
+     * Request body in XML
      *
      * &lt;hostConfig&gt;
      * &#x20;&lt;dataLayerAddress&gt;00:00:00:00:01:01&lt;/dataLayerAddress&gt;
@@ -402,11 +394,11 @@ public class HostTrackerNorthbound {
      * &#x20;&lt;nodeId&gt;00:00:00:00:00:00:00:01&lt;/nodeId&gt;
      * &#x20;&lt;nodeConnectorType&gt;OF&lt;/nodeConnectorType&gt;
      * &#x20;&lt;nodeConnectorId&gt;9&lt;/nodeConnectorId&gt;
-     * &#x20;&lt;vlan&gt;0&lt;/vlan&gt;
-     * &#x20;&lt;staticHost&gt;false&lt;/staticHost&gt;
+     * &#x20;&lt;vlan&gt;1&lt;/vlan&gt;
+     * &#x20;&lt;staticHost&gt;true&lt;/staticHost&gt;
      * &lt;/hostConfig&gt;
      *
-     * Request in JSON:
+     * Request body in JSON:
      *
      * {
      * &#x20;"dataLayerAddress":"00:00:00:00:01:01",
@@ -414,14 +406,14 @@ public class HostTrackerNorthbound {
      * &#x20;"nodeId":"00:00:00:00:00:00:00:01",
      * &#x20;"nodeConnectorType":"OF",
      * &#x20;"nodeConnectorId":"9",
-     * &#x20;"vlan":"0",
-     * &#x20;"staticHost":"false",
+     * &#x20;"vlan":"1",
+     * &#x20;"staticHost":"true",
      * &#x20;"networkAddress":"1.1.1.1"
      * }
      * </pre>
      */
 
-    @Path("/{containerName}/{networkAddress}")
+    @Path("/{containerName}/address/{networkAddress}")
     @PUT
     @Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
     @StatusCodes({
@@ -432,7 +424,7 @@ public class HostTrackerNorthbound {
             @ResponseCode(code = 503, condition = "One or more of Controller services are unavailable") })
     public Response addHost(@Context UriInfo uriInfo, @PathParam("containerName") String containerName,
             @PathParam("networkAddress") String networkAddress,
-            @TypeHint(HostConfig.class) JAXBElement<HostConfig> hostConfig) {
+            @TypeHint(HostConfig.class) HostConfig hostConfig) {
 
         if (!NorthboundUtils.isAuthorized(getUserName(), containerName, Privilege.WRITE, this)) {
             return Response.status(Response.Status.UNAUTHORIZED)
@@ -443,7 +435,7 @@ public class HostTrackerNorthbound {
 
         IfIptoHost hostTracker = getIfIpToHostService(containerName);
 
-        HostConfig hc = hostConfig.getValue();
+        HostConfig hc = hostConfig;
         if (!networkAddress.equals(hc.getNetworkAddress())) {
             return Response.status(Response.Status.CONFLICT)
                     .entity("Resource name in config object doesn't match URI")
@@ -475,9 +467,15 @@ 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}/{networkAddress}")
+    @Path("/{containerName}/address/{networkAddress}")
     @DELETE
     @Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
     @StatusCodes({