Merge branch 'topic/master/neutron-yang-migration' to branch 'master'

[netvirt.git] / openstack / net-virt / src / main / java / org / opendaylight / ovsdb / openstack / netvirt / api / NetworkingProvider.java

diff --git a/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/api/NetworkingProvider.java b/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/api/NetworkingProvider.java
index 953a0b17f256cc0063930aa1457e177b338b6f0e..791e07aeac811c11945e363bb85501ba53d093db 100644 (file)
--- a/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/api/NetworkingProvider.java
+++ b/openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/api/NetworkingProvider.java
@@ -8,7 +8,7 @@
 
 package org.opendaylight.ovsdb.openstack.netvirt.api;
 
-import org.opendaylight.neutron.spi.NeutronNetwork;
+import org.opendaylight.ovsdb.openstack.netvirt.translator.NeutronNetwork;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
 import org.osgi.framework.ServiceReference;
@@ -19,27 +19,37 @@ import org.osgi.framework.ServiceReference;
 public interface NetworkingProvider {
 
     /**
-     * Returns the name of the NetworkingProvider
+     * @return the name of the NetworkingProvider
      */
     String getName();
 
     /**
-     * Return true if the provider supports Network Service Instances
+     * @return true if the provider supports Network Service Instances
      */
     boolean supportsServices();
 
     /**
-     * Return true if the provider supports per-tenant or "static" tunneling
+     * @return true if the provider supports per-tenant or "static" tunneling
      */
     boolean hasPerTenantTunneling();
 
     /**
      * Handle Interface Update Callback Method
+     * @param network Neutron Network attached to the interface
+     * @param source Source node where interface is attached
+     * @param intf Termination point attached to the node
+     * @return true if interface update handled successfully
      */
     boolean handleInterfaceUpdate(NeutronNetwork network, Node source, OvsdbTerminationPointAugmentation intf);
 
     /**
      * Handle Interface Delete Callback Method
+     * @param tunnelType Type of the tunnel (e.g. vxlan)
+     * @param network Neutron Network associated with the removed interface
+     * @param source Source node where interface was attached
+     * @param intf Termination point associated to the deleted interface
+     * @param isLastInstanceOnNode is last interface attached to the node ?
+     * @return true if interface delete handled successfully
      */
     boolean handleInterfaceDelete(String tunnelType, NeutronNetwork network, Node source,
                                   OvsdbTerminationPointAugmentation intf, boolean isLastInstanceOnNode);
@@ -49,11 +59,13 @@ public interface NetworkingProvider {
      * This method provides a set of common functionalities to initialize the Flow rules of an OVSDB node
      * that are Openflow Version specific. Hence we have this method in addition to the following
      * Openflow Node specific initialization method.
+     * @param node Node on which flow rules are going to be installed
      */
     void initializeFlowRules(Node node);
 
     /**
      * Initialize the Flow rules for a given OpenFlow node
+     * @param openflowNode Node on which flow rules are going to be installed
      */
     void initializeOFFlowRules(Node openflowNode);
 }