Photon-Model: add NetworkInterfaceService service

TODO- Add unit tests

Change-Id: I276de9c34a42411bb80514056c369e9441836634

Author: Jake Dsouza

README.md

@@ -23,7 +23,7 @@ If you're looking to play with the code, keep reading.
 The product is arranged in a single repository, with subdirectories arranged by language. See the individual READMEs for instructions on building the code.
 
 * [Devbox](devbox-photon/README.md): Devbox uses [Vagrant](http://vagrantup.com) to create a small standalone deployment of Photon Controller for test purposes.
-* [Java](java/README.md): Most of the Photon Controller management plane is written in Java, with many individual services implemented on top of the [Xenon framework](http://vmware.github.io/xenon) -- coming soon.
+* [Java](java/README.md): Most of the Photon Controller management plane is written in Java, with many individual services implemented on top of the [Xenon framework](http://vmware.github.io/xenon).
 * [Python](python/README.md): The ESX agent and its test and analysis collateral are implemented in Python.
 * [Ruby](ruby/README.md): The Photon Controller CLI is implemented in Ruby, as are the integration tests for the product.
   * **Note**: The Ruby CLI will soon be replaced with a Golang version.

java/photon-model/src/main/java/com/vmware/photon/controller/model/UriPaths.java

@@ -11,12 +11,13 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package com.vmware.photon.controller.model;
+  package com.vmware.photon.controller.model;
 
 /**
  * Service paths used in the provisioning model.
  */
 public class UriPaths {
   public static final String RESOURCES = "/resources";
+  public static final String RESOURCES_NETWORKS = RESOURCES + "/networks";
   public static final String PROVISIONING = "/provisioning";
 }

java/photon-model/src/main/java/com/vmware/photon/controller/model/resources/NetworkInterfaceFactoryService.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2015 VMware, Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License.  You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed
+ * under the License is distributed on an "AS IS" BASIS, without warranties or
+ * conditions of any kind, EITHER EXPRESS OR IMPLIED.  See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package com.vmware.photon.controller.model.resources;
+
+import com.vmware.dcp.common.FactoryService;
+import com.vmware.dcp.common.Operation;
+import com.vmware.dcp.common.Service;
+import com.vmware.photon.controller.model.UriPaths;
+
+import java.util.UUID;
+
+/**
+ * Creates a NetworkInterfaceService instance.
+ */
+public class NetworkInterfaceFactoryService extends FactoryService {
+  public static final String SELF_LINK = UriPaths.RESOURCES_NETWORKS + "/interfaces";
+
+  public NetworkInterfaceFactoryService() {
+    super(NetworkInterfaceService.NetworkInterfaceState.class);
+  }
+
+  @Override
+  public void handlePost(Operation post) {
+    if (!post.hasBody()) {
+      post.fail(new IllegalArgumentException("body is required"));
+      return;
+    }
+
+    NetworkInterfaceService.NetworkInterfaceState initState = post.getBody(NetworkInterfaceService
+        .NetworkInterfaceState.class);
+
+    if (initState.id == null) {
+      initState.id = UUID.randomUUID().toString();
+    }
+    initState.documentSelfLink = initState.id;
+    post.setBody(initState).complete();
+
+  }
+
+  @Override
+  public Service createServiceInstance() {
+    return new NetworkInterfaceService();
+  }
+}

java/photon-model/src/main/java/com/vmware/photon/controller/model/resources/NetworkInterfaceService.java

@@ -0,0 +1,119 @@
+/*
+ * Copyright 2015 VMware, Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License.  You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed
+ * under the License is distributed on an "AS IS" BASIS, without warranties or
+ * conditions of any kind, EITHER EXPRESS OR IMPLIED.  See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package com.vmware.photon.controller.model.resources;
+
+import com.vmware.dcp.common.Operation;
+import com.vmware.dcp.common.ServiceDocument;
+import com.vmware.dcp.common.ServiceDocumentDescription;
+import com.vmware.dcp.common.StatefulService;
+
+import org.apache.commons.validator.routines.InetAddressValidator;
+
+import java.util.List;
+
+/**
+ * Represents a network interface.
+ */
+public class NetworkInterfaceService extends StatefulService {
+
+  /**
+   * Represents the state of a network interface.
+   */
+  public static class NetworkInterfaceState extends ServiceDocument {
+    /**
+     * The name or id of the interface on the compute.
+     */
+    public String id;
+
+    /**
+     * The description for the interface.  If this is an interface which uses DHCP
+     * to resolve its address, then this is a link to the subnet document.
+     */
+    public String networkDescriptionLink;
+
+    /**
+     * The IP information of the interface. Optional.
+     */
+    public String leaseLink;
+
+    /**
+     * The static IP of the interface.  Optional.  If networkDescriptionLink / leaseLink
+     * are defined, this cannot be and vice versa.
+     */
+    public String address;
+
+    /**
+     * The bridge this interface will be instantiated on. Optional.
+     */
+    public String networkBridgeLink;
+
+    /**
+     * A list of tenant links which can access this network interface.
+     */
+    public List<String> tenantLinks;
+  }
+
+  public NetworkInterfaceService() {
+    super(NetworkInterfaceState.class);
+    super.toggleOption(ServiceOption.PERSISTENCE, true);
+    super.toggleOption(ServiceOption.REPLICATION, true);
+    super.toggleOption(ServiceOption.OWNER_SELECTION, true);
+  }
+
+  @Override
+  public void handlePost(Operation post) {
+    NetworkInterfaceState body = post.getBody(NetworkInterfaceState.class);
+
+    try {
+      if (body.address != null) {
+        if (body.networkDescriptionLink != null) {
+          throw new IllegalArgumentException(
+              "both networkDescriptionLink and IP cannot be set");
+        }
+        InetAddressValidator.getInstance().isValidInet4Address(body.address);
+      } else if (body.networkDescriptionLink == null) {
+        throw new IllegalArgumentException(
+            "either IP or networkDescriptionLink must be set");
+      }
+    } catch (Exception e) {
+      post.fail(e);
+      return;
+    }
+
+    post.complete();
+  }
+
+  @Override
+  public void handlePatch(Operation patch) {
+    NetworkInterfaceState currentState = getState(patch);
+    NetworkInterfaceState patchBody = patch.getBody(NetworkInterfaceState.class);
+
+    if (patchBody.id != null) {
+      currentState.id = patchBody.id;
+    }
+
+    if (patchBody.leaseLink != null) {
+      currentState.leaseLink = patchBody.leaseLink;
+    }
+
+    patch.setBody(currentState).complete();
+  }
+
+  @Override
+  public ServiceDocument getDocumentTemplate() {
+    ServiceDocument td = super.getDocumentTemplate();
+    ServiceDocumentDescription.expandTenantLinks(td.documentDescription);
+    return td;
+  }
+}