NETVIRT-1630 migrate to md-sal APIs
[netvirt.git] / vpnmanager / impl / src / main / java / org / opendaylight / netvirt / vpnmanager / VpnInstanceListener.java
index 498ea32f3d6d2aafcb30b84eb2d864a69ec155fa..229d5568e1deba029fbf920d6a2a114c5a9b3306 100644 (file)
@@ -7,29 +7,27 @@
  */
 package org.opendaylight.netvirt.vpnmanager;
 
-import static org.opendaylight.controller.md.sal.binding.api.WriteTransaction.CREATE_MISSING_PARENTS;
 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
+import static org.opendaylight.mdsal.binding.api.WriteTransaction.CREATE_MISSING_PARENTS;
 
-import com.google.common.base.Optional;
 import com.google.common.util.concurrent.FutureCallback;
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.MoreExecutors;
-import java.math.BigInteger;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.Optional;
 import java.util.concurrent.Callable;
-import javax.annotation.PostConstruct;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.locks.ReentrantLock;
+import javax.annotation.PreDestroy;
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import org.eclipse.jdt.annotation.Nullable;
-import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
-import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
 import org.opendaylight.genius.infra.Datastore.Configuration;
 import org.opendaylight.genius.infra.Datastore.Operational;
@@ -47,15 +45,15 @@ import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
 import org.opendaylight.genius.mdsalutil.matches.MatchTunnelId;
+import org.opendaylight.genius.utils.JvmGlobalLocks;
 import org.opendaylight.genius.utils.SystemPropertyReader;
 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
+import org.opendaylight.infrautils.utils.concurrent.Executors;
 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
-import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
-import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
-import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.VpnTargets;
-import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets.VpnTarget;
-import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
+import org.opendaylight.serviceutils.tools.listener.AbstractAsyncDataTreeChangeListener;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.ExternalTunnelList;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel;
@@ -67,14 +65,21 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnTargetsBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTargetBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTargetKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.VpnInstances;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstance;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn.instance.VpnTargets;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn.instance.vpntargets.VpnTarget;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.Uint32;
+import org.opendaylight.yangtools.yang.common.Uint64;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 @Singleton
-public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInstance, VpnInstanceListener> {
+public class VpnInstanceListener extends AbstractAsyncDataTreeChangeListener<VpnInstance> {
     private static final Logger LOG = LoggerFactory.getLogger(VpnInstanceListener.class);
     private static final String LOGGING_PREFIX_ADD = "VPN-ADD:";
+    private static final String LOGGING_PREFIX_UPDATE = "VPN-UPDATE:";
     private static final String LOGGING_PREFIX_DELETE = "VPN-REMOVE:";
     private final DataBroker dataBroker;
     private final ManagedNewTransactionRunner txRunner;
@@ -91,7 +96,9 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
             final VpnInterfaceManager vpnInterfaceManager, final IFibManager fibManager,
             final VpnOpDataSyncer vpnOpDataSyncer, final IMdsalApiManager mdsalManager,
             final JobCoordinator jobCoordinator, VpnUtil vpnUtil) {
-        super(VpnInstance.class, VpnInstanceListener.class);
+        super(dataBroker, LogicalDatastoreType.CONFIGURATION,
+                InstanceIdentifier.create(VpnInstances.class).child(VpnInstance.class),
+                Executors.newListeningSingleThreadExecutor("VpnInstanceListener", LOG));
         this.dataBroker = dataBroker;
         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
         this.idManager = idManager;
@@ -101,52 +108,60 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
         this.mdsalManager = mdsalManager;
         this.jobCoordinator = jobCoordinator;
         this.vpnUtil = vpnUtil;
+        start();
     }
 
-    @PostConstruct
     public void start() {
         LOG.info("{} start", getClass().getSimpleName());
-        registerListener(LogicalDatastoreType.CONFIGURATION, dataBroker);
     }
 
     @Override
-    protected InstanceIdentifier<VpnInstance> getWildCardPath() {
-        return InstanceIdentifier.create(VpnInstances.class).child(VpnInstance.class);
+    @PreDestroy
+    public void close() {
+        super.close();
+        Executors.shutdownAndAwaitTermination(getExecutorService());
     }
 
-    @Override
-    protected VpnInstanceListener getDataTreeChangeListener() {
-        return VpnInstanceListener.this;
-    }
 
     @Override
-    protected void remove(InstanceIdentifier<VpnInstance> identifier, VpnInstance del) {
-        LOG.trace("{} remove: VPN event key: {}, value: {}", LOGGING_PREFIX_DELETE, identifier, del);
+    public void remove(InstanceIdentifier<VpnInstance> identifier, VpnInstance del) {
+        LOG.trace("{} : VPN event key: {}, value: {}", LOGGING_PREFIX_DELETE, identifier, del);
         final String vpnName = del.getVpnInstanceName();
         Optional<VpnInstanceOpDataEntry> vpnOpValue;
-        String primaryRd = VpnUtil.getPrimaryRd(del);
+        String primaryRd = vpnUtil.getVpnRd(vpnName);
+        if (primaryRd == null) {
+            LOG.error("{}, failed to remove VPN: primaryRd is null for vpn {}", LOGGING_PREFIX_DELETE, vpnName);
+            return;
+        }
 
         //TODO(vpnteam): Entire code would need refactoring to listen only on the parent object - VPNInstance
         try {
             vpnOpValue = SingleTransactionDataBroker.syncReadOptional(dataBroker, LogicalDatastoreType.OPERATIONAL,
                     VpnUtil.getVpnInstanceOpDataIdentifier(primaryRd));
-        } catch (ReadFailedException e) {
-            LOG.error("{} remove: Exception when attempting to retrieve VpnInstanceOpDataEntry for VPN {}. ",
+        } catch (InterruptedException | ExecutionException e) {
+            LOG.error("{}, failed to remove VPN: Exception while retrieving VpnInstanceOpDataEntry for VPN {}. ",
                     LOGGING_PREFIX_DELETE,  vpnName, e);
             return;
         }
 
         if (!vpnOpValue.isPresent()) {
-            LOG.error("{} remove: Unable to retrieve VpnInstanceOpDataEntry for VPN {}. ", LOGGING_PREFIX_DELETE,
-                    vpnName);
+            LOG.error("{}, failed to remove VPN: Unable to retrieve VpnInstanceOpDataEntry for VPN {}. ",
+                LOGGING_PREFIX_DELETE, vpnName);
             return;
         } else {
             jobCoordinator.enqueueJob("VPN-" + vpnName, () ->
                 Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
-                    VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd)
-                            .setVpnState(VpnInstanceOpDataEntry.VpnState.PendingDelete);
-                    InstanceIdentifier<VpnInstanceOpDataEntry> id =
-                            VpnUtil.getVpnInstanceOpDataIdentifier(primaryRd);
+                    VpnInstanceOpDataEntryBuilder builder = null;
+                    InstanceIdentifier<VpnInstanceOpDataEntry> id = null;
+                    if (primaryRd != null) {
+                        builder = new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd)
+                                .setVpnState(VpnInstanceOpDataEntry.VpnState.PendingDelete);
+                        id = VpnUtil.getVpnInstanceOpDataIdentifier(primaryRd);
+                    } else {
+                        builder = new VpnInstanceOpDataEntryBuilder().setVrfId(vpnName)
+                                .setVpnState(VpnInstanceOpDataEntry.VpnState.PendingDelete);
+                        id = VpnUtil.getVpnInstanceOpDataIdentifier(vpnName);
+                    }
                     tx.merge(id, builder.build());
 
                     LOG.info("{} call: Operational status set to PENDING_DELETE for vpn {} with rd {}",
@@ -156,31 +171,31 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
     }
 
     @Override
-    protected void update(InstanceIdentifier<VpnInstance> identifier,
+    public void update(InstanceIdentifier<VpnInstance> identifier,
         VpnInstance original, VpnInstance update) {
         LOG.trace("VPN-UPDATE: update: VPN event key: {}, value: {}.", identifier, update);
         String vpnName = update.getVpnInstanceName();
-        if (original.getIpv4Family() != null && update.getIpv4Family() != null
-                && original.getIpv4Family().getRouteDistinguisher() != null
-                && update.getIpv4Family().getRouteDistinguisher() != null
-                && original.getIpv4Family().getRouteDistinguisher().size()
-                !=  update.getIpv4Family().getRouteDistinguisher().size()) {
+        if (original != null && update != null
+                && original.getRouteDistinguisher() != null
+                && update.getRouteDistinguisher() != null
+                && original.getRouteDistinguisher().size()
+                !=  update.getRouteDistinguisher().size()) {
             LOG.debug("VPN-UPDATE: VpnInstance:{} updated with new RDs: {} from old RDs: {}", vpnName,
-                    update.getIpv4Family().getRouteDistinguisher(),  original.getIpv4Family().getRouteDistinguisher());
-            vpnUtil.updateVpnInstanceWithRdList(vpnName, update.getIpv4Family().getRouteDistinguisher());
+                    update.getRouteDistinguisher(),  original.getRouteDistinguisher());
+            vpnUtil.updateVpnInstanceWithRdList(vpnName, update.getRouteDistinguisher());
         }
         vpnInterfaceManager.updateVpnInterfacesForUnProcessAdjancencies(vpnName);
     }
 
     @Override
-    protected void add(final InstanceIdentifier<VpnInstance> identifier, final VpnInstance value) {
+    public void add(final InstanceIdentifier<VpnInstance> identifier, final VpnInstance value) {
         LOG.trace("{} add: Add VPN event key: {}, value: {}", LOGGING_PREFIX_ADD, identifier, value);
         final String vpnName = value.getVpnInstanceName();
         jobCoordinator.enqueueJob("VPN-" + vpnName, new AddVpnInstanceWorker(dataBroker, value),
                 SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
     }
 
-    private class AddVpnInstanceWorker implements Callable<List<ListenableFuture<Void>>> {
+    private class AddVpnInstanceWorker implements Callable<List<? extends ListenableFuture<?>>> {
         private final Logger log = LoggerFactory.getLogger(AddVpnInstanceWorker.class);
         VpnInstance vpnInstance;
         DataBroker broker;
@@ -199,8 +214,9 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
             futures.add(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION, confTx -> {
                 ListenableFuture<Void> future = txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, operTx ->
                         addVpnInstance(vpnInstance, confTx, operTx));
-                ListenableFutures.addErrorLogging(future, LOG, "{} call: error creating VPN {}", LOGGING_PREFIX_ADD,
-                        vpnInstance.getVpnInstanceName());
+                ListenableFutures.addErrorLogging(future, LOG, "{} call: error creating VPN {} rd {}",
+                        LOGGING_PREFIX_ADD, vpnInstance.getVpnInstanceName(),
+                        vpnInstance.getRouteDistinguisher());
                 futures.add(future);
             }));
             Futures.addCallback(Futures.allAsList(futures),
@@ -224,11 +240,10 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
                 addVpnInstance(value, writeConfigTxn, tx)), LOG, "Error adding VPN instance {}", value);
             return;
         }
-        VpnAfConfig config = value.getIpv4Family();
         String vpnInstanceName = value.getVpnInstanceName();
 
-        long vpnId = vpnUtil.getUniqueId(VpnConstants.VPN_IDPOOL_NAME, vpnInstanceName);
-        if (vpnId == 0) {
+        Uint32 vpnId = vpnUtil.getUniqueId(VpnConstants.VPN_IDPOOL_NAME, vpnInstanceName);
+        if (vpnId.longValue() == 0) {
             LOG.error("{} addVpnInstance: Unable to fetch label from Id Manager. Bailing out of adding operational"
                     + " data for Vpn Instance {}", LOGGING_PREFIX_ADD, value.getVpnInstanceName());
             return;
@@ -268,8 +283,7 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
         VpnInstanceOpDataEntryBuilder builder =
                 new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd).setVpnId(vpnId)
                         .setVpnInstanceName(vpnInstanceName)
-                        .setVpnState(VpnInstanceOpDataEntry.VpnState.Created)
-                        .setIpv4Configured(false).setIpv6Configured(false);
+                        .setVpnState(VpnInstanceOpDataEntry.VpnState.Created);
         if (VpnUtil.isBgpVpn(vpnInstanceName, primaryRd)) {
             List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn
                 .instance.op.data.entry.vpntargets.VpnTarget> opVpnTargetList = new ArrayList<>();
@@ -277,10 +291,10 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
             if (value.getL3vni() != null) {
                 builder.setL3vni(value.getL3vni());
             }
-            if (value.getType() == VpnInstance.Type.L2) {
+            if (value.isL2vpn()) {
                 builder.setType(VpnInstanceOpDataEntry.Type.L2);
             }
-            VpnTargets vpnTargets = config.getVpnTargets();
+            VpnTargets vpnTargets = value.getVpnTargets();
             if (vpnTargets != null) {
                 List<VpnTarget> vpnTargetList = vpnTargets.getVpnTarget();
                 if (vpnTargetList != null) {
@@ -298,7 +312,7 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
             VpnTargetsBuilder vpnTargetsBuilder = new VpnTargetsBuilder().setVpnTarget(opVpnTargetList);
             builder.setVpnTargets(vpnTargetsBuilder.build());
 
-            List<String> rds = config.getRouteDistinguisher();
+            List<String> rds = value.getRouteDistinguisher();
             builder.setRd(rds);
         } else {
             builder.setBgpvpnType(VpnInstanceOpDataEntry.BgpvpnType.VPN);
@@ -327,8 +341,7 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
             if rd is null, then its either a router vpn instance (or) a vlan external network vpn instance.
             if rd is non-null, then it is a bgpvpn instance
              */
-            VpnAfConfig config = vpnInstance.getIpv4Family();
-            List<String> rd = config.getRouteDistinguisher();
+            List<String> rd = vpnInstance.getRouteDistinguisher();
             if (rd == null || addBgpVrf()) {
                 notifyTask();
                 vpnInterfaceManager.vpnInstanceIsReady(vpnName);
@@ -347,21 +360,25 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
 
                 // install flow
                 List<MatchInfo> mkMatches = new ArrayList<>();
-                mkMatches.add(new MatchTunnelId(BigInteger.valueOf(vpnInstance.getL3vni())));
+                mkMatches.add(new MatchTunnelId(Uint64.valueOf(vpnInstance.getL3vni())));
 
                 List<InstructionInfo> instructions =
                         Arrays.asList(new InstructionWriteMetadata(MetaDataUtil.getVpnIdMetadata(vpnInstanceOpDataEntry
-                                .getVpnId()), MetaDataUtil.METADATA_MASK_VRFID),
+                                .getVpnId().toJava()), MetaDataUtil.METADATA_MASK_VRFID),
                                 new InstructionGotoTable(NwConstants.L3_GW_MAC_TABLE));
-
-                for (BigInteger dpnId: NWUtil.getOperativeDPNs(dataBroker)) {
-                    String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
-                            vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
-                    FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpnId,
-                            NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef, VpnConstants.DEFAULT_FLOW_PRIORITY,
-                            "VxLAN VPN Tunnel Bind Service", 0, 0, NwConstants.COOKIE_VM_FIB_TABLE,
-                            mkMatches, instructions);
-                    mdsalManager.installFlow(dpnId, flowEntity);
+                try {
+                    for (Uint64 dpnId: NWUtil.getOperativeDPNs(dataBroker)) {
+                        String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
+                                vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
+                        FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpnId,
+                                NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef,
+                                VpnConstants.DEFAULT_FLOW_PRIORITY, "VxLAN VPN Tunnel Bind Service",
+                                0, 0, NwConstants.COOKIE_VM_FIB_TABLE, mkMatches, instructions);
+                        mdsalManager.installFlow(dpnId, flowEntity);
+                    }
+                } catch (ExecutionException | InterruptedException e) {
+                    LOG.error("PostAddVpnInstanceWorker: Exception while getting the list of Operative DPNs for Vpn {}",
+                            vpnName, e);
                 }
 
                 ///////////////////////
@@ -371,17 +388,21 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
         // TODO Clean up the exception handling
         @SuppressWarnings("checkstyle:IllegalCatch")
         private boolean addBgpVrf() {
-            VpnAfConfig config = vpnInstance.getIpv4Family();
             String primaryRd = vpnUtil.getPrimaryRd(vpnName);
-            List<VpnTarget> vpnTargetList = config.getVpnTargets().getVpnTarget();
+            List<VpnTarget> vpnTargetList = vpnInstance.getVpnTargets().getVpnTarget();
 
             if (vpnTargetList == null) {
                 log.error("{} addBgpVrf: vpn target list is empty for vpn {} RD {}", LOGGING_PREFIX_ADD,
                         this.vpnName, primaryRd);
                 return false;
             }
-            synchronized (vpnName.intern()) {
+            // FIXME: separate out to somehow?
+            final ReentrantLock lock = JvmGlobalLocks.getLockForString(vpnName);
+            lock.lock();
+            try {
                 fibManager.addVrfTable(primaryRd, null);
+            } finally {
+                lock.unlock();
             }
             vpnInterfaceManager.handleVpnsExportingRoutes(this.vpnName, primaryRd);
             return true;
@@ -412,12 +433,14 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
         try {
             return SingleTransactionDataBroker.syncReadOptional(dataBroker, LogicalDatastoreType.OPERATIONAL,
-                    id).orNull();
-        } catch (ReadFailedException e) {
+                    id).orElse(null);
+        } catch (InterruptedException | ExecutionException e) {
             throw new RuntimeException("Error reading VPN instance data for " + rd, e);
         }
     }
 
+    @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
+            justification = "https://github.com/spotbugs/spotbugs/issues/811")
     private List<String> getDcGatewayTunnelInterfaceNameList() {
         List<String> tunnelInterfaceNameList = new ArrayList<>();
         try {
@@ -462,13 +485,15 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
                 }
 
             }
-        } catch (ReadFailedException e) {
+        } catch (InterruptedException | ExecutionException e) {
             LOG.error("getDcGatewayTunnelInterfaceNameList: Failed to read data store");
         }
         return tunnelInterfaceNameList;
     }
 
-    private String getFibFlowRef(BigInteger dpnId, short tableId, String vpnName, int priority) {
+    @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
+            justification = "https://github.com/spotbugs/spotbugs/issues/811")
+    private String getFibFlowRef(Uint64 dpnId, short tableId, String vpnName, int priority) {
         return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
                 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
     }