ovsdb enable checkstyle on error
[ovsdb.git] / southbound / southbound-impl / src / main / java / org / opendaylight / ovsdb / southbound / SouthboundProvider.java
index 9d9ea1d58ee9cfb4b2c9e866116778efa47f7dbf..a5a6df82d396ff33c319c607acc0fefdc3878c64 100644 (file)
@@ -7,14 +7,22 @@
  */
 package org.opendaylight.ovsdb.southbound;
 
+import com.google.common.base.Optional;
+import com.google.common.util.concurrent.CheckedFuture;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
+import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
+import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
+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.EntityOwnershipListenerRegistration;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
-import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
+import org.opendaylight.controller.sal.core.api.model.SchemaService;
 import org.opendaylight.ovsdb.lib.OvsdbConnection;
-import org.opendaylight.ovsdb.lib.impl.OvsdbConnectionService;
 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvoker;
 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvokerImpl;
 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
@@ -22,58 +30,95 @@ import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.
 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
+import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeSerializer;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.base.Optional;
-import com.google.common.util.concurrent.CheckedFuture;
-
-public class SouthboundProvider implements BindingAwareProvider, AutoCloseable {
+public class SouthboundProvider implements AutoCloseable {
 
     private static final Logger LOG = LoggerFactory.getLogger(SouthboundProvider.class);
-    private DataBroker db;
+    private static final String ENTITY_TYPE = "ovsdb-southbound-provider";
+
+    public static DataBroker getDb() {
+        return db;
+    }
+
+    private static DataBroker db;
     private OvsdbConnectionManager cm;
-    private OvsdbNodeDataChangeListener ovsdbNodeListener;
-    private OvsdbManagedNodeDataChangeListener ovsdbManagedNodeListener;
-    private OvsdbTerminationPointDataChangeListener ovsdbTerminationPointListener;
     private TransactionInvoker txInvoker;
+    private OvsdbDataTreeChangeListener ovsdbDataTreeChangeListener;
+    private EntityOwnershipService entityOwnershipService;
+    private EntityOwnershipCandidateRegistration registration;
+    private SouthboundPluginInstanceEntityOwnershipListener providerOwnershipChangeListener;
+    private OvsdbConnection ovsdbConnection;
 
+    public SouthboundProvider(final DataBroker dataBroker,
+            final EntityOwnershipService entityOwnershipServiceDependency,
+            final OvsdbConnection ovsdbConnection,
+            final SchemaService schemaService,
+            final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer) {
+        this.db = dataBroker;
+        this.entityOwnershipService = entityOwnershipServiceDependency;
+        registration = null;
+        this.ovsdbConnection = ovsdbConnection;
 
-    @Override
-    public void onSessionInitiated(ProviderContext session) {
+        SouthboundUtil.setInstanceIdentifierCodec(new InstanceIdentifierCodec(schemaService,
+                bindingNormalizedNodeSerializer));
+        LOG.info("SouthboundProvider ovsdbConnectionService: {}", ovsdbConnection);
+    }
+
+    /**
+     * Used by blueprint when starting the container.
+     */
+    public void init() {
         LOG.info("SouthboundProvider Session Initiated");
-        db = session.getSALService(DataBroker.class);
         this.txInvoker = new TransactionInvokerImpl(db);
-        cm = new OvsdbConnectionManager(db,txInvoker);
-        ovsdbNodeListener = new OvsdbNodeDataChangeListener(db, cm);
-        ovsdbManagedNodeListener = new OvsdbManagedNodeDataChangeListener(db, cm);
-        ovsdbTerminationPointListener = new OvsdbTerminationPointDataChangeListener(db, cm);
-        initializeOvsdbTopology(LogicalDatastoreType.OPERATIONAL);
-        initializeOvsdbTopology(LogicalDatastoreType.CONFIGURATION);
-        OvsdbConnection ovsdbConnection = new OvsdbConnectionService();
-        ovsdbConnection.registerConnectionListener(cm);
-        ovsdbConnection.startOvsdbManager(SouthboundConstants.DEFAULT_OVSDB_PORT);
+        cm = new OvsdbConnectionManager(db,txInvoker,entityOwnershipService, ovsdbConnection);
+        ovsdbDataTreeChangeListener = new OvsdbDataTreeChangeListener(db, cm);
+
+        //Register listener for entityOnwership changes
+        providerOwnershipChangeListener =
+                new SouthboundPluginInstanceEntityOwnershipListener(this,this.entityOwnershipService);
+        entityOwnershipService.registerListener(ENTITY_TYPE,providerOwnershipChangeListener);
+
+        //register instance entity to get the ownership of the provider
+        Entity instanceEntity = new Entity(ENTITY_TYPE, ENTITY_TYPE);
+        try {
+            Optional<EntityOwnershipState> ownershipStateOpt = entityOwnershipService.getOwnershipState(instanceEntity);
+            registration = entityOwnershipService.registerCandidate(instanceEntity);
+            if (ownershipStateOpt.isPresent()) {
+                EntityOwnershipState ownershipState = ownershipStateOpt.get();
+                if (ownershipState.hasOwner() && !ownershipState.isOwner()) {
+                    ovsdbConnection.registerConnectionListener(cm);
+                    ovsdbConnection.startOvsdbManager(SouthboundConstants.DEFAULT_OVSDB_PORT);
+                    LOG.info("*This* instance of OVSDB southbound provider is set as a SLAVE instance");
+                }
+            }
+        } catch (CandidateAlreadyRegisteredException e) {
+            LOG.warn("OVSDB Southbound Provider instance entity {} was already "
+                    + "registered for ownership", instanceEntity, e);
+        }
     }
 
     @Override
-    public void close() throws Exception {
+    public void close() {
         LOG.info("SouthboundProvider Closed");
         cm.close();
-        ovsdbNodeListener.close();
-        ovsdbManagedNodeListener.close();
-        ovsdbTerminationPointListener.close();
+        ovsdbDataTreeChangeListener.close();
+        registration.close();
+        providerOwnershipChangeListener.close();
     }
 
     private void initializeOvsdbTopology(LogicalDatastoreType type) {
         InstanceIdentifier<Topology> path = InstanceIdentifier
                 .create(NetworkTopology.class)
                 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID));
+        initializeTopology(type);
         ReadWriteTransaction transaction = db.newReadWriteTransaction();
-        initializeTopology(transaction,type);
         CheckedFuture<Optional<Topology>, ReadFailedException> ovsdbTp = transaction.read(type, path);
         try {
-            if(!ovsdbTp.get().isPresent()) {
+            if (!ovsdbTp.get().isPresent()) {
                 TopologyBuilder tpb = new TopologyBuilder();
                 tpb.setTopologyId(SouthboundConstants.OVSDB_TOPOLOGY_ID);
                 transaction.put(type, path, tpb.build());
@@ -82,21 +127,59 @@ public class SouthboundProvider implements BindingAwareProvider, AutoCloseable {
                 transaction.cancel();
             }
         } catch (Exception e) {
-            LOG.error("Error initializing ovsdb topology {}",e);
+            LOG.error("Error initializing ovsdb topology", e);
+        }
+    }
+
+    private void initializeTopology(LogicalDatastoreType type) {
+        ReadWriteTransaction transaction = db.newReadWriteTransaction();
+        InstanceIdentifier<NetworkTopology> path = InstanceIdentifier.create(NetworkTopology.class);
+        CheckedFuture<Optional<NetworkTopology>, ReadFailedException> topology = transaction.read(type,path);
+        try {
+            if (!topology.get().isPresent()) {
+                NetworkTopologyBuilder ntb = new NetworkTopologyBuilder();
+                transaction.put(type,path,ntb.build());
+                transaction.submit();
+            } else {
+                transaction.cancel();
+            }
+        } catch (Exception e) {
+            LOG.error("Error initializing ovsdb topology", e);
+        }
+    }
+
+    public void handleOwnershipChange(EntityOwnershipChange ownershipChange) {
+        if (ownershipChange.isOwner()) {
+            LOG.info("*This* instance of OVSDB southbound provider is set as a MASTER instance");
+            LOG.info("Initialize OVSDB topology {} in operational and config data store if not already present",
+                    SouthboundConstants.OVSDB_TOPOLOGY_ID);
+            initializeOvsdbTopology(LogicalDatastoreType.OPERATIONAL);
+            initializeOvsdbTopology(LogicalDatastoreType.CONFIGURATION);
+        } else {
+            LOG.info("*This* instance of OVSDB southbound provider is set as a SLAVE instance");
         }
+        ovsdbConnection.registerConnectionListener(cm);
+        ovsdbConnection.startOvsdbManager(SouthboundConstants.DEFAULT_OVSDB_PORT);
     }
 
-    private void initializeTopology(ReadWriteTransaction t, LogicalDatastoreType type) {
-        InstanceIdentifier<NetworkTopology> path = InstanceIdentifier
-                .create(NetworkTopology.class);
-       CheckedFuture<Optional<NetworkTopology>, ReadFailedException> tp = t.read(type,path);
-       try {
-           if(!tp.get().isPresent()) {
-               NetworkTopologyBuilder ntb = new NetworkTopologyBuilder();
-               t.put(type,path,ntb.build());
-           }
-       } catch (Exception e) {
-           LOG.error("Error initializing ovsdb topology {}",e);
-       }
+    private class SouthboundPluginInstanceEntityOwnershipListener implements EntityOwnershipListener {
+        private SouthboundProvider sp;
+        private EntityOwnershipListenerRegistration listenerRegistration;
+
+        SouthboundPluginInstanceEntityOwnershipListener(SouthboundProvider sp,
+                EntityOwnershipService entityOwnershipService) {
+            this.sp = sp;
+            listenerRegistration = entityOwnershipService.registerListener(ENTITY_TYPE, this);
+        }
+
+        public void close() {
+            this.listenerRegistration.close();
+        }
+
+        @Override
+        public void ownershipChanged(EntityOwnershipChange ownershipChange) {
+            sp.handleOwnershipChange(ownershipChange);
+        }
     }
+
 }