BUG:6058 - Currently the Operational Datastore does not get cleaned up and the switch

continues to persist if the node that is connected to the switch goes
down. The patch addresses it

Change-Id: I0e8a65c8f38ac9d4de1def65be1daf7afbab5d18
Signed-off-by: Shuva Kar <shuva.jyoti.kar@ericsson.com>

diff --git a/applications/inventory-manager/src/main/java/org/opendaylight/openflowplugin/applications/inventory/manager/FlowCapableInventoryProvider.java b/applications/inventory-manager/src/main/java/org/opendaylight/openflowplugin/applications/inventory/manager/FlowCapableInventoryProvider.java
index c7dd08e20661128bdb59c65f7e167d59617c983c..afcf1fd4c244d8edf1147378121b660fc06cf4cc 100644 (file)
--- a/applications/inventory-manager/src/main/java/org/opendaylight/openflowplugin/applications/inventory/manager/FlowCapableInventoryProvider.java
+++ b/applications/inventory-manager/src/main/java/org/opendaylight/openflowplugin/applications/inventory/manager/FlowCapableInventoryProvider.java
@@ -51,7 +51,8 @@ class FlowCapableInventoryProvider implements AutoCloseable, Runnable, Transacti
     }
 
     void start() {
-        final NodeChangeCommiter changeCommiter = new NodeChangeCommiter(FlowCapableInventoryProvider.this);
+        final NodeChangeCommiter changeCommiter = new NodeChangeCommiter(FlowCapableInventoryProvider.this, eos);
+        changeCommiter.init();
         this.listenerRegistration = this.notificationService.registerNotificationListener(changeCommiter);
 
         final NodeTablesFeatureCommitter nodeTablesFeatureCommitter =

diff --git a/applications/inventory-manager/src/main/java/org/opendaylight/openflowplugin/applications/inventory/manager/NodeChangeCommiter.java b/applications/inventory-manager/src/main/java/org/opendaylight/openflowplugin/applications/inventory/manager/NodeChangeCommiter.java
index 35b6b3d717dc345e93926e33198820587f74607d..24d2968c615337a7bb4e0676f3abd1fedd9e0f46 100644 (file)
--- a/applications/inventory-manager/src/main/java/org/opendaylight/openflowplugin/applications/inventory/manager/NodeChangeCommiter.java
+++ b/applications/inventory-manager/src/main/java/org/opendaylight/openflowplugin/applications/inventory/manager/NodeChangeCommiter.java
@@ -14,8 +14,16 @@ import com.google.common.cache.CacheBuilder;
 import com.google.common.util.concurrent.CheckedFuture;
 import com.google.common.util.concurrent.FutureCallback;
 import com.google.common.util.concurrent.Futures;
+
+import java.util.Map;
 import java.util.concurrent.TimeUnit;
+
+import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
+import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
@@ -29,15 +37,21 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.No
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-class NodeChangeCommiter implements OpendaylightInventoryListener {
+class NodeChangeCommiter implements OpendaylightInventoryListener,EntityOwnershipListener {
     private static final Logger LOG = LoggerFactory.getLogger(NodeChangeCommiter.class);
 
     private final FlowCapableInventoryProvider manager;
+    private final EntityOwnershipService entityOwnershipService;
+
+    private final String DEVICE_TYPE = "openflow";
 
     // cache for nodes which were deleted, we get more than one nodeRemoved notification
     private Cache<NodeRef, Boolean> deletedNodeCache =
@@ -47,13 +61,28 @@ class NodeChangeCommiter implements OpendaylightInventoryListener {
     private Cache<NodeConnectorRef, Boolean> deletedNodeConnectorCache =
             CacheBuilder.newBuilder().maximumSize(1000000).expireAfterWrite(10, TimeUnit.SECONDS).build();
 
-    public NodeChangeCommiter(final FlowCapableInventoryProvider manager) {
+    public NodeChangeCommiter(final FlowCapableInventoryProvider manager, final EntityOwnershipService entityOwnershipService) {
         this.manager = Preconditions.checkNotNull(manager);
+        this.entityOwnershipService = Preconditions.checkNotNull(entityOwnershipService);
+    }
+
+    public void init(){
+        registerEntityOwnershipChangeListener();
+    }
+
+    public void registerEntityOwnershipChangeListener() {
+        if(entityOwnershipService!=null) {
+            if(LOG.isDebugEnabled()) {
+                LOG.debug("registerEntityOwnershipChangeListener:" +
+                        " Registering entity ownership change listener for entities of type {}", DEVICE_TYPE);
+            }
+            entityOwnershipService.registerListener(DEVICE_TYPE, this);
+        }
     }
 
     @Override
     public synchronized void onNodeConnectorRemoved(final NodeConnectorRemoved connector) {
-        if(deletedNodeConnectorCache.getIfPresent(connector.getNodeConnectorRef()) == null){
+        if (deletedNodeConnectorCache.getIfPresent(connector.getNodeConnectorRef()) == null) {
             deletedNodeConnectorCache.put(connector.getNodeConnectorRef(), Boolean.TRUE);
         } else {
             //its been noted that creating an operation for already removed node-connectors, fails
@@ -63,7 +92,9 @@ class NodeChangeCommiter implements OpendaylightInventoryListener {
             return;
         }
 
-        if(!manager.deviceDataDeleteAllowed(getNodeId(connector.getNodeConnectorRef().getValue()))) { return; }
+        if (!manager.deviceDataDeleteAllowed(getNodeId(connector.getNodeConnectorRef().getValue()))) {
+            return;
+        }
 
         LOG.debug("Node connector removed notification received, {}", connector.getNodeConnectorRef().getValue());
         manager.enqueue(new InventoryOperation() {
@@ -78,7 +109,7 @@ class NodeChangeCommiter implements OpendaylightInventoryListener {
 
     @Override
     public synchronized void onNodeConnectorUpdated(final NodeConnectorUpdated connector) {
-        if (deletedNodeConnectorCache.getIfPresent(connector.getNodeConnectorRef()) != null){
+        if (deletedNodeConnectorCache.getIfPresent(connector.getNodeConnectorRef()) != null) {
             deletedNodeConnectorCache.invalidate(connector.getNodeConnectorRef());
         }
 
@@ -107,7 +138,7 @@ class NodeChangeCommiter implements OpendaylightInventoryListener {
     @Override
     public synchronized void onNodeRemoved(final NodeRemoved node) {
 
-        if(deletedNodeCache.getIfPresent(node.getNodeRef()) == null){
+        if (deletedNodeCache.getIfPresent(node.getNodeRef()) == null) {
             deletedNodeCache.put(node.getNodeRef(), Boolean.TRUE);
         } else {
             //its been noted that creating an operation for already removed node, fails
@@ -117,7 +148,9 @@ class NodeChangeCommiter implements OpendaylightInventoryListener {
             return;
         }
 
-        if(!manager.deviceDataDeleteAllowed(getNodeId(node.getNodeRef().getValue()))) { return; }
+        if (!manager.deviceDataDeleteAllowed(getNodeId(node.getNodeRef().getValue()))) {
+            return;
+        }
 
         LOG.debug("Node removed notification received, {}", node.getNodeRef().getValue());
         manager.enqueue(new InventoryOperation() {
@@ -132,7 +165,7 @@ class NodeChangeCommiter implements OpendaylightInventoryListener {
 
     @Override
     public synchronized void onNodeUpdated(final NodeUpdated node) {
-        if (deletedNodeCache.getIfPresent(node.getNodeRef()) != null){
+        if (deletedNodeCache.getIfPresent(node.getNodeRef()) != null) {
             deletedNodeCache.invalidate(node.getNodeRef());
         }
 
@@ -196,7 +229,54 @@ class NodeChangeCommiter implements OpendaylightInventoryListener {
         });
     }
 
+    @Override
+    public void ownershipChanged(final EntityOwnershipChange entityOwnershipChange) {
+        final Entity entity = entityOwnershipChange.getEntity();
+        NodeId nodeId = getNodeID(entity.getId());
+        InstanceIdentifier<Node> identifier = identifierFromNodeId(nodeId);
+
+        if (!entityOwnershipChange.hasOwner()) {
+            //NodeChangeCommitter : entityOwnershipChange - hasOwner,is false for node
+            LOG.debug("Node: {} is not owned by any controller instance, cleaning up the inventory data store ",nodeId);
+            NodeRef nodeRef = new NodeRef(identifier);
+            NodeRemoved nodeRemoved = nodeRemoved(nodeRef);
+            onNodeRemoved(nodeRemoved);
+
+        }else{
+            //
+            LOG.debug("Node {} is currently owned by other controller instance", nodeId);
+        }
+    }
+
+
+
+    private static NodeId getNodeID(YangInstanceIdentifier yangInstanceIdentifier) {
+
+        QName ENTITY_QNAME =
+                org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.
+                        controller.md.sal.core.general.entity.rev150820.Entity.QNAME;
+        QName ENTITY_NAME = QName.create(ENTITY_QNAME, "name");
+
+        YangInstanceIdentifier.NodeIdentifierWithPredicates niWPredicates =
+                (YangInstanceIdentifier.NodeIdentifierWithPredicates) yangInstanceIdentifier.getLastPathArgument();
+        Map<QName, Object> keyValMap = niWPredicates.getKeyValues();
+        String nodeIdStr = (String) (keyValMap.get(ENTITY_NAME));
+        return new NodeId(nodeIdStr);
+    }
+
+    private static InstanceIdentifier<Node> identifierFromNodeId(NodeId nodeId) {
+        NodeKey nodeKey = new NodeKey(nodeId);
+        InstanceIdentifier.InstanceIdentifierBuilder<Node> builder =
+                InstanceIdentifier.builder(Nodes.class).child(Node.class, nodeKey);
+        return builder.build();
+    }
+
+    private static NodeRemoved nodeRemoved(final NodeRef nodeRef) {
+        NodeRemovedBuilder builder = new NodeRemovedBuilder();
+        builder.setNodeRef(nodeRef);
+        return builder.build();
+    }
     private NodeId getNodeId(InstanceIdentifier<?> iid) {
         return iid.firstKeyOf(Node.class).getId();
     }
-}
+}
\ No newline at end of file