Bump upstreams
[lispflowmapping.git] / mappingservice / dsbackend / src / main / java / org / opendaylight / lispflowmapping / dsbackend / DataStoreBackEnd.java
index 2ce6aafdf3c1ce86d4697f3185244ff8c48fbd0c..e02a61e8ec7bee11d25d47fe076c998a892e1e72 100644 (file)
@@ -7,10 +7,13 @@
  */
 package org.opendaylight.lispflowmapping.dsbackend;
 
-import com.google.common.base.Preconditions;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.util.concurrent.FutureCallback;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.MoreExecutors;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
@@ -19,9 +22,7 @@ import java.util.concurrent.ExecutionException;
 import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
 import org.opendaylight.mdsal.binding.api.DataBroker;
 import org.opendaylight.mdsal.binding.api.ReadTransaction;
-import org.opendaylight.mdsal.binding.api.Transaction;
 import org.opendaylight.mdsal.binding.api.TransactionChain;
-import org.opendaylight.mdsal.binding.api.TransactionChainListener;
 import org.opendaylight.mdsal.binding.api.WriteTransaction;
 import org.opendaylight.mdsal.common.api.CommitInfo;
 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
@@ -34,7 +35,9 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev15090
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.database.LastUpdated;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.database.LastUpdatedBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.database.VirtualNetworkIdentifier;
+import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.Empty;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -42,25 +45,44 @@ import org.slf4j.LoggerFactory;
  * Stores data coming from the mapping database RPCs into the MD-SAL datastore.
  *
  * @author Lorand Jakab
- *
  */
-public class DataStoreBackEnd implements TransactionChainListener {
+public class DataStoreBackEnd {
     private static final Logger LOG = LoggerFactory.getLogger(DataStoreBackEnd.class);
     private static final InstanceIdentifier<MappingDatabase> DATABASE_ROOT =
             InstanceIdentifier.create(MappingDatabase.class);
     private static final InstanceIdentifier<LastUpdated> LAST_UPDATED =
             InstanceIdentifier.create(MappingDatabase.class).child(LastUpdated.class);
-    private final DataBroker broker;
-    private TransactionChain txChain;
 
-    public DataStoreBackEnd(DataBroker broker) {
-        this.broker = broker;
-        createTransactionChain();
-    }
+    private final TransactionChain configTxChain;
+    private final TransactionChain operTxChain;
 
-    public void createTransactionChain() {
+    @SuppressFBWarnings(value = "MC_OVERRIDABLE_METHOD_CALL_IN_CONSTRUCTOR", justification = "Non-final for mocking")
+    public DataStoreBackEnd(DataBroker broker) {
         LOG.debug("Creating DataStoreBackEnd transaction chain...");
-        txChain = broker.createMergingTransactionChain(this);
+        configTxChain = broker.createMergingTransactionChain();
+        operTxChain = broker.createMergingTransactionChain();
+        configTxChain.addCallback(new FutureCallback<Empty>() {
+            @Override
+            public void onSuccess(Empty result) {
+                onTransactionChainSuccessful(configTxChain);
+            }
+
+            @Override
+            public void onFailure(Throwable cause) {
+                onTransactionChainFailed(configTxChain, cause);
+            }
+        });
+        operTxChain.addCallback(new FutureCallback<Empty>() {
+            @Override
+            public void onSuccess(Empty result) {
+                onTransactionChainSuccessful(operTxChain);
+            }
+
+            @Override
+            public void onFailure(Throwable cause) {
+                onTransactionChainFailed(operTxChain, cause);
+            }
+        });
     }
 
     public void addAuthenticationKey(AuthenticationKey authenticationKey) {
@@ -91,8 +113,7 @@ public class DataStoreBackEnd implements TransactionChainListener {
     // This method assumes that it is only called for southbound originated Map-Registers
     public void addXtrIdMapping(XtrIdMapping mapping) {
         XtrId xtrId = mapping.getMappingRecord().getXtrId();
-        Preconditions.checkNotNull(xtrId, "Make sure you only call addXtrIdMapping when the MappingRecord "
-                + "contains an xTR-ID");
+        requireNonNull(xtrId, "Make sure you only call addXtrIdMapping when the MappingRecord contains an xTR-ID");
         if (LOG.isDebugEnabled()) {
             LOG.debug("MD-SAL: Adding mapping for {}, xTR-ID {}",
                     LispAddressStringifier.getString(mapping.getMappingRecord().getEid()), xtrId);
@@ -129,8 +150,7 @@ public class DataStoreBackEnd implements TransactionChainListener {
 
     public void removeXtrIdMapping(XtrIdMapping mapping) {
         XtrId xtrId = mapping.getMappingRecord().getXtrId();
-        Preconditions.checkNotNull(xtrId, "Make sure you only call addXtrIdMapping when the MappingRecord "
-                + "contains an xTR-ID");
+        requireNonNull(xtrId, "Make sure you only call addXtrIdMapping when the MappingRecord contains an xTR-ID");
         if (LOG.isDebugEnabled()) {
             LOG.debug("MD-SAL: Removing mapping for {}, xTR-ID {}",
                     LispAddressStringifier.getString(mapping.getMappingRecord().getEid()), xtrId);
@@ -196,8 +216,8 @@ public class DataStoreBackEnd implements TransactionChainListener {
         MappingDatabase mdb = readTransaction(DATABASE_ROOT, logicalDataStore);
 
         if (mdb != null && mdb.getVirtualNetworkIdentifier() != null) {
-            for (VirtualNetworkIdentifier id : mdb.getVirtualNetworkIdentifier()) {
-                List<Mapping> ms = id.getMapping();
+            for (VirtualNetworkIdentifier id : mdb.nonnullVirtualNetworkIdentifier().values()) {
+                List<Mapping> ms = new ArrayList<>(id.nonnullMapping().values());
                 if (ms != null) {
                     mappings.addAll(ms);
                 }
@@ -213,8 +233,8 @@ public class DataStoreBackEnd implements TransactionChainListener {
         MappingDatabase mdb = readTransaction(DATABASE_ROOT, LogicalDatastoreType.CONFIGURATION);
 
         if (mdb != null && mdb.getVirtualNetworkIdentifier() != null) {
-            for (VirtualNetworkIdentifier id : mdb.getVirtualNetworkIdentifier()) {
-                List<AuthenticationKey> keys = id.getAuthenticationKey();
+            for (VirtualNetworkIdentifier id : mdb.nonnullVirtualNetworkIdentifier().values()) {
+                List<AuthenticationKey> keys = new ArrayList<>(id.nonnullAuthenticationKey().values());
                 if (keys != null) {
                     authKeys.addAll(keys);
                 }
@@ -226,7 +246,7 @@ public class DataStoreBackEnd implements TransactionChainListener {
 
     public void saveLastUpdateTimestamp() {
         Long timestamp = System.currentTimeMillis();
-        LOG.debug("MD-SAL: Saving last update timestamp to operational datastore: {}", new Date(timestamp).toString());
+        LOG.debug("MD-SAL: Saving last update timestamp to operational datastore: {}", new Date(timestamp));
         writePutTransaction(LAST_UPDATED, new LastUpdatedBuilder().setLastUpdated(timestamp).build(),
                 LogicalDatastoreType.OPERATIONAL, "Couldn't save last update timestamp to operational datastore");
     }
@@ -255,14 +275,22 @@ public class DataStoreBackEnd implements TransactionChainListener {
                 : LogicalDatastoreType.CONFIGURATION;
     }
 
-    private <U extends org.opendaylight.yangtools.yang.binding.DataObject> void writePutTransaction(
-            InstanceIdentifier<U> addIID, U data, LogicalDatastoreType logicalDatastoreType, String errMsg) {
-        WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
-        writeTx.put(logicalDatastoreType, addIID, data, true);
-        writeTx.commit().addCallback(new FutureCallback<CommitInfo>() {
+    private TransactionChain getChain(LogicalDatastoreType logicalDatastoreType) {
+        return switch (logicalDatastoreType) {
+            case CONFIGURATION -> configTxChain;
+            case OPERATIONAL -> operTxChain;
+        };
+    }
 
+    private <U extends DataObject> void writePutTransaction(InstanceIdentifier<U> addIID, U data,
+            LogicalDatastoreType logicalDatastoreType, String errMsg) {
+        WriteTransaction writeTx = getChain(logicalDatastoreType).newWriteOnlyTransaction();
+        // TODO: is is a utility method, hence we do not have enough lifecycle knowledge to use plain put()
+        writeTx.mergeParentStructurePut(logicalDatastoreType, addIID, data);
+        writeTx.commit().addCallback(new FutureCallback<CommitInfo>() {
             @Override
             public void onSuccess(CommitInfo result) {
+                // No-op
             }
 
             @Override
@@ -272,16 +300,16 @@ public class DataStoreBackEnd implements TransactionChainListener {
         }, MoreExecutors.directExecutor());
     }
 
-    private <U extends org.opendaylight.yangtools.yang.binding.DataObject> U readTransaction(
-            InstanceIdentifier<U> readIID, LogicalDatastoreType logicalDatastoreType) {
+    private <U extends DataObject> U readTransaction(InstanceIdentifier<U> readIID,
+            LogicalDatastoreType logicalDatastoreType) {
         final ListenableFuture<Optional<U>> readFuture;
-        try (ReadTransaction readTx = txChain.newReadOnlyTransaction()) {
+        try (ReadTransaction readTx = getChain(logicalDatastoreType).newReadOnlyTransaction()) {
             readFuture = readTx.read(logicalDatastoreType, readIID);
         }
         try {
             Optional<U> optionalDataObject = readFuture.get();
             if (optionalDataObject != null && optionalDataObject.isPresent()) {
-                return optionalDataObject.get();
+                return optionalDataObject.orElseThrow();
             } else {
                 LOG.debug("{}: Failed to read", Thread.currentThread().getStackTrace()[1]);
             }
@@ -291,10 +319,9 @@ public class DataStoreBackEnd implements TransactionChainListener {
         return null;
     }
 
-    private <U extends org.opendaylight.yangtools.yang.binding.DataObject> void deleteTransaction(
-            InstanceIdentifier<U> deleteIID, LogicalDatastoreType logicalDatastoreType, String errMsg) {
-
-        WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
+    private <U extends DataObject> void deleteTransaction(InstanceIdentifier<U> deleteIID,
+            LogicalDatastoreType logicalDatastoreType, String errMsg) {
+        WriteTransaction writeTx = getChain(logicalDatastoreType).newWriteOnlyTransaction();
         writeTx.delete(logicalDatastoreType, deleteIID);
         writeTx.commit().addCallback(new FutureCallback<CommitInfo>() {
             @Override
@@ -308,19 +335,19 @@ public class DataStoreBackEnd implements TransactionChainListener {
         }, MoreExecutors.directExecutor());
     }
 
-    @Override
-    public void onTransactionChainFailed(TransactionChain chain, Transaction transaction, Throwable cause) {
-        LOG.error("Broken chain {} in DataStoreBackEnd, transaction {}, cause {}", chain, transaction.getIdentifier(),
-                cause);
+    @VisibleForTesting
+    void onTransactionChainFailed(TransactionChain chain, Throwable cause) {
+        LOG.error("Broken chain {} in DataStoreBackEnd, cause {}", chain, cause.getMessage());
     }
 
-    @Override
-    public void onTransactionChainSuccessful(TransactionChain chain) {
+    @VisibleForTesting
+    void onTransactionChainSuccessful(TransactionChain chain) {
         LOG.info("DataStoreBackEnd closed successfully, chain {}", chain);
     }
 
     public void closeTransactionChain() {
         LOG.debug("Closing DataStoreBackEnd transaction chain...");
-        txChain.close();
+        configTxChain.close();
+        operTxChain.close();
     }
 }