Convert vpnmanager-impl to use blueprint annotations
[netvirt.git] / vpnservice / vpnmanager / vpnmanager-impl / src / main / java / org / opendaylight / netvirt / vpnmanager / VpnInstanceListener.java
index d9aa5d113eca4cff4fff15603d1ca6457fee9ed6..37a82ec50395030383aebcff1d52121df46991bf 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 - 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
+ * Copyright (c) 2015 - 2017 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -8,28 +8,39 @@
 package org.opendaylight.netvirt.vpnmanager;
 
 import com.google.common.base.Optional;
-import com.google.common.util.concurrent.CheckedFuture;
 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.ThreadFactoryBuilder;
+import com.google.common.util.concurrent.MoreExecutors;
+import java.math.BigInteger;
 import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.Callable;
-import java.util.concurrent.ConcurrentHashMap;
-import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.ExecutionException;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
-import java.util.concurrent.ThreadFactory;
+import javax.annotation.PostConstruct;
+import javax.inject.Inject;
+import javax.inject.Singleton;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
-import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
-import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
-import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
+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.mdsalutil.FlowEntity;
+import org.opendaylight.genius.mdsalutil.InstructionInfo;
+import org.opendaylight.genius.mdsalutil.MDSALUtil;
+import org.opendaylight.genius.mdsalutil.MatchInfo;
+import org.opendaylight.genius.mdsalutil.MetaDataUtil;
+import org.opendaylight.genius.mdsalutil.NWUtil;
+import org.opendaylight.genius.mdsalutil.NwConstants;
+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.SystemPropertyReader;
+import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
 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;
@@ -37,46 +48,49 @@ import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev14081
 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.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;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.DcGatewayIpList;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.dc.gateway.ip.list.DcGatewayIp;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
 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.VpnToDpnList;
-
 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.l3vpn.rev130911.vpn.to.extraroute.Vpn;
-import org.opendaylight.yangtools.concepts.ListenerRegistration;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInstance, VpnInstanceListener>
-        implements AutoCloseable {
+@Singleton
+public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInstance, VpnInstanceListener> {
     private static final Logger LOG = LoggerFactory.getLogger(VpnInstanceListener.class);
-    private ListenerRegistration<DataChangeListener> listenerRegistration;
+    private static final String LOGGING_PREFIX_ADD = "VPN-ADD:";
+    private static final String LOGGING_PREFIX_DELETE = "VPN-REMOVE:";
     private final DataBroker dataBroker;
-    private final IBgpManager bgpManager;
     private final IdManagerService idManager;
     private final VpnInterfaceManager vpnInterfaceManager;
     private final IFibManager fibManager;
-    private static final ThreadFactory threadFactory = new ThreadFactoryBuilder()
-            .setNameFormat("NV-VpnMgr-%d").build();
-    private ExecutorService executorService = Executors.newSingleThreadExecutor(threadFactory);
-    private ConcurrentMap<String, Runnable> vpnOpMap = new ConcurrentHashMap<String, Runnable>();
-
-    public VpnInstanceListener(final DataBroker dataBroker, final IBgpManager bgpManager,
-                               final IdManagerService idManager,
-                               final VpnInterfaceManager vpnInterfaceManager,
-                               final IFibManager fibManager) {
+    private final VpnOpDataSyncer vpnOpDataNotifier;
+    private final IMdsalApiManager mdsalManager;
+    private final JobCoordinator jobCoordinator;
+
+    @Inject
+    public VpnInstanceListener(final DataBroker dataBroker, final IdManagerService idManager,
+            final VpnInterfaceManager vpnInterfaceManager, final IFibManager fibManager,
+            final VpnOpDataSyncer vpnOpDataSyncer, final IMdsalApiManager mdsalManager,
+            final JobCoordinator jobCoordinator) {
         super(VpnInstance.class, VpnInstanceListener.class);
         this.dataBroker = dataBroker;
-        this.bgpManager = bgpManager;
         this.idManager = idManager;
         this.vpnInterfaceManager = vpnInterfaceManager;
         this.fibManager = fibManager;
+        this.vpnOpDataNotifier = vpnOpDataSyncer;
+        this.mdsalManager = mdsalManager;
+        this.jobCoordinator = jobCoordinator;
     }
 
+    @PostConstruct
     public void start() {
         LOG.info("{} start", getClass().getSimpleName());
         registerListener(LogicalDatastoreType.CONFIGURATION, dataBroker);
@@ -92,247 +106,68 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
         return VpnInstanceListener.this;
     }
 
-    void notifyTaskIfRequired(String vpnName) {
-        Runnable notifyTask = vpnOpMap.remove(vpnName);
-        if (notifyTask == null) {
-            LOG.trace("VpnInstanceListener update: No Notify Task queued for vpnName {}", vpnName);
-            return;
-        }
-        executorService.execute(notifyTask);
-    }
-
-    private void waitForOpRemoval(String rd, String vpnName) {
-        //wait till DCN for update on VPN Instance Op Data signals that vpn interfaces linked to this vpn instance is zero
-        //TODO(vpnteam): Entire code would need refactoring to listen only on the parent object - VPNInstance
-        VpnInstanceOpDataEntry vpnOpEntry = null;
-        Long intfCount = 0L;
-        Long currentIntfCount = 0L;
-        Integer retryCount = 3;
-        long timeout = VpnConstants.MIN_WAIT_TIME_IN_MILLISECONDS;
-        Optional<VpnInstanceOpDataEntry> vpnOpValue = null;
-        vpnOpValue = VpnUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL,
-                VpnUtil.getVpnInstanceOpDataIdentifier(rd));
-
-        if ((vpnOpValue != null) && (vpnOpValue.isPresent())) {
-            vpnOpEntry = vpnOpValue.get();
-            List<VpnToDpnList> dpnToVpns = vpnOpEntry.getVpnToDpnList();
-            if (dpnToVpns != null) {
-                for (VpnToDpnList dpn : dpnToVpns) {
-                    if (dpn.getVpnInterfaces() != null) {
-                        intfCount = intfCount + dpn.getVpnInterfaces().size();
-                    }
-                }
-            }
-            //intfCount = vpnOpEntry.getVpnInterfaceCount();
-            while (true) {
-                if (intfCount > 0) {
-                    // Minimum wait time of 5 seconds for one VPN Interface clearance (inclusive of full trace on)
-                    timeout = intfCount * VpnConstants.MIN_WAIT_TIME_IN_MILLISECONDS;
-                    // Maximum wait time of 90 seconds for all VPN Interfaces clearance (inclusive of full trace on)
-                    if (timeout > VpnConstants.MAX_WAIT_TIME_IN_MILLISECONDS) {
-                        timeout = VpnConstants.MAX_WAIT_TIME_IN_MILLISECONDS;
-                    }
-                    LOG.info("VPNInstance removal count of interface at {} for for rd {}, vpnname {}",
-                            intfCount, rd, vpnName);
-                }
-                LOG.info("VPNInstance removal thread waiting for {} seconds for rd {}, vpnname {}",
-                        (timeout / 1000), rd, vpnName);
-
-                try {
-                    Thread.sleep(timeout);
-                } catch (InterruptedException e) {
-                }
-
-                // Check current interface count
-                vpnOpValue = VpnUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL,
-                        VpnUtil.getVpnInstanceOpDataIdentifier(rd));
-                if ((vpnOpValue != null) && (vpnOpValue.isPresent())) {
-                    vpnOpEntry = vpnOpValue.get();
-                    dpnToVpns = vpnOpEntry.getVpnToDpnList();
-                    currentIntfCount = 0L;
-                    if (dpnToVpns != null) {
-                        for (VpnToDpnList dpn : dpnToVpns) {
-                            if (dpn.getVpnInterfaces() != null) {
-                                currentIntfCount = currentIntfCount + dpn.getVpnInterfaces().size();
-                            }
-                        }
-                    }
-                    if ((currentIntfCount == 0) || (currentIntfCount >= intfCount)) {
-                        // Either the FibManager completed its job to cleanup all vpnInterfaces in VPN
-                        // OR
-                        // There is no progress by FibManager in removing all the interfaces even after good time!
-                        // In either case, let us quit and take our chances.
-                        //TODO(vpnteam): L3VPN refactoring to take care of this case.
-                        if ((dpnToVpns == null) || dpnToVpns.size() <= 0) {
-                            LOG.info("VPN Instance vpn {} rd {} ready for removal, exiting wait loop", vpnName, rd);
-                            break;
-                        } else {
-                            if (retryCount > 0) {
-                                retryCount--;
-                                LOG.info("Retrying clearing vpn with vpnname {} rd {} since current interface count {} ", vpnName, rd, currentIntfCount);
-                                if (currentIntfCount > 0) {
-                                    intfCount = currentIntfCount;
-                                } else {
-                                    LOG.info("Current interface count is zero, but instance Op for vpn {} and rd {} not cleared yet. Waiting for 5 more seconds.", vpnName, rd);
-                                    intfCount = 1L;
-                                }
-                            } else {
-                                LOG.info("VPNInstance bailing out of wait loop as current interface count is {} and max retries exceeded for for vpnName {}, rd {}",
-                                        currentIntfCount, vpnName, rd);
-                                break;
-                            }
-                        }
-                    }
-                } else {
-                    // There is no VPNOPEntry.  Something else happened on the system !
-                    // So let us quit and take our chances.
-                    //TODO(vpnteam): L3VPN refactoring to take care of this case.
-                    break;
-                }
-            }
-        }
-        LOG.info("Returned out of waiting for  Op Data removal for rd {}, vpnname {}", rd, vpnName);
-    }
     @Override
     protected void remove(InstanceIdentifier<VpnInstance> identifier, VpnInstance del) {
-        LOG.trace("Remove VPN event key: {}, value: {}", identifier, del);
+        LOG.trace("{} remove: VPN event key: {}, value: {}", LOGGING_PREFIX_DELETE, identifier, del);
         final String vpnName = del.getVpnInstanceName();
-        final String rd = del.getIpv4Family().getRouteDistinguisher();
-        final long vpnId = VpnUtil.getVpnId(dataBroker, vpnName);
-        Optional<VpnInstanceOpDataEntry> vpnOpValue = null;
+        Optional<VpnInstanceOpDataEntry> vpnOpValue;
+        String primaryRd = VpnUtil.getPrimaryRd(del);
 
         //TODO(vpnteam): Entire code would need refactoring to listen only on the parent object - VPNInstance
         try {
-            if ((rd != null) && (!rd.isEmpty())) {
-                vpnOpValue = VpnUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL,
-                        VpnUtil.getVpnInstanceOpDataIdentifier(rd));
-            } else {
-                vpnOpValue = VpnUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL,
-                        VpnUtil.getVpnInstanceOpDataIdentifier(vpnName));
-            }
-        } catch (Exception e) {
-            LOG.error("Exception when attempting to retrieve VpnInstanceOpDataEntry for VPN {}. ", vpnName, e);
+            vpnOpValue = SingleTransactionDataBroker.syncReadOptional(dataBroker, LogicalDatastoreType.OPERATIONAL,
+                    VpnUtil.getVpnInstanceOpDataIdentifier(primaryRd));
+        } catch (ReadFailedException e) {
+            LOG.error("{} remove: Exception when attempting to retrieve VpnInstanceOpDataEntry for VPN {}. ",
+                    LOGGING_PREFIX_DELETE,  vpnName, e);
             return;
         }
 
-        if (vpnOpValue == null || !vpnOpValue.isPresent()) {
-            LOG.error("Unable to retrieve VpnInstanceOpDataEntry for VPN {}. ", vpnName);
+        if (!vpnOpValue.isPresent()) {
+            LOG.error("{} remove: Unable to retrieve VpnInstanceOpDataEntry for VPN {}. ", LOGGING_PREFIX_DELETE,
+                    vpnName);
             return;
-        }
-
-        DataStoreJobCoordinator dataStoreCoordinator = DataStoreJobCoordinator.getInstance();
-        dataStoreCoordinator.enqueueJob("VPN-" + vpnName,
-                new DeleteVpnInstanceWorker(idManager, dataBroker, del));
-    }
-
-    private class DeleteVpnInstanceWorker implements Callable<List<ListenableFuture<Void>>> {
-        IdManagerService idManager;
-        DataBroker broker;
-        VpnInstance vpnInstance;
-
-        public DeleteVpnInstanceWorker(IdManagerService idManager,
-                                       DataBroker broker,
-                                       VpnInstance value) {
-            this.idManager = idManager;
-            this.broker = broker;
-            this.vpnInstance = value;
-        }
-
-        @Override
-        public List<ListenableFuture<Void>> call() throws Exception {
-            final String vpnName = vpnInstance.getVpnInstanceName();
-            final String rd = vpnInstance.getIpv4Family().getRouteDistinguisher();
-            final long vpnId = VpnUtil.getVpnId(broker, vpnName);
-            WriteTransaction writeTxn = broker.newWriteOnlyTransaction();
-            if ((rd != null) && (!rd.isEmpty())) {
-                waitForOpRemoval(rd, vpnName);
-            } else {
-                waitForOpRemoval(vpnName, vpnName);
-            }
-
-            // Clean up VpnInstanceToVpnId from Config DS
-            VpnUtil.removeVpnIdToVpnInstance(broker, vpnId, writeTxn);
-            VpnUtil.removeVpnInstanceToVpnId(broker, vpnName, writeTxn);
-            LOG.trace("Removed vpnIdentifier for  rd{} vpnname {}", rd, vpnName);
-            if (rd != null) {
-                synchronized (vpnName.intern()) {
-                    fibManager.removeVrfTable(broker, rd, null);
-                }
-                try {
-                    bgpManager.deleteVrf(rd, false);
-                } catch (Exception e) {
-                    LOG.error("Exception when removing VRF from BGP for RD {} in VPN {} exception " + e, rd, vpnName);
-                }
-
-                // Clean up VPNExtraRoutes Operational DS
-                InstanceIdentifier<Vpn> vpnToExtraroute = VpnUtil.getVpnToExtrarouteIdentifier(rd);
-                Optional<Vpn> optVpnToExtraroute = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, vpnToExtraroute);
-                if (optVpnToExtraroute.isPresent()) {
-                    VpnUtil.removeVpnExtraRouteForVpn(broker, rd, writeTxn);
-                }
-
-                // Clean up VPNInstanceOpDataEntry
-                VpnUtil.removeVpnOpInstance(broker, rd, writeTxn);
-            } else {
-                // Clean up FIB Entries Config DS
-                synchronized (vpnName.intern()) {
-                    fibManager.removeVrfTable(broker, vpnName, null);
-                }
-                // Clean up VPNExtraRoutes Operational DS
-                InstanceIdentifier<Vpn> vpnToExtraroute = VpnUtil.getVpnToExtrarouteIdentifier(vpnName);
-                Optional<Vpn> optVpnToExtraroute = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, vpnToExtraroute);
-                if (optVpnToExtraroute.isPresent()) {
-                    VpnUtil.removeVpnExtraRouteForVpn(broker, vpnName, writeTxn);
-                }
-
-                // Clean up VPNInstanceOpDataEntry
-                VpnUtil.removeVpnOpInstance(broker, vpnName, writeTxn);
-            }
-            // Clean up PrefixToInterface Operational DS
-            VpnUtil.removePrefixToInterfaceForVpnId(broker, vpnId, writeTxn);
-
-            // Clean up L3NextHop Operational DS
-            VpnUtil.removeL3nexthopForVpnId(broker, vpnId, writeTxn);
-
-            // Release the ID used for this VPN back to IdManager
-            VpnUtil.releaseId(idManager, VpnConstants.VPN_IDPOOL_NAME, vpnName);
-
-            List<ListenableFuture<Void>> futures = new ArrayList<>();
-            futures.add(writeTxn.submit());
-            return futures;
+        } else {
+            jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
+                VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd)
+                        .setVpnState(VpnInstanceOpDataEntry.VpnState.PendingDelete);
+                InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(primaryRd);
+                WriteTransaction writeTxn = dataBroker.newWriteOnlyTransaction();
+                writeTxn.merge(LogicalDatastoreType.OPERATIONAL, id, builder.build());
+
+                LOG.info("{} call: Operational status set to PENDING_DELETE for vpn {} with rd {}",
+                        LOGGING_PREFIX_DELETE, vpnName, primaryRd);
+                return Collections.singletonList(writeTxn.submit());
+            }, SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
         }
     }
 
     @Override
     protected void update(InstanceIdentifier<VpnInstance> identifier,
-                          VpnInstance original, VpnInstance update) {
-        LOG.trace("Update VPN event key: {}, value: {}", identifier, update);
+        VpnInstance original, VpnInstance update) {
+        LOG.trace("VPN-UPDATE: update: VPN event key: {}, value: {}. Ignoring", identifier, update);
+        String vpnName = update.getVpnInstanceName();
+        vpnInterfaceManager.updateVpnInterfacesForUnProcessAdjancencies(dataBroker,vpnName);
     }
 
     @Override
     protected void add(final InstanceIdentifier<VpnInstance> identifier, final VpnInstance value) {
-        LOG.trace("Add VPN event key: {}, value: {}", identifier, value);
-        final VpnAfConfig config = value.getIpv4Family();
-        final String rd = config.getRouteDistinguisher();
+        LOG.trace("{} add: Add VPN event key: {}, value: {}", LOGGING_PREFIX_ADD, identifier, value);
         final String vpnName = value.getVpnInstanceName();
-
-        DataStoreJobCoordinator dataStoreCoordinator = DataStoreJobCoordinator.getInstance();
-        dataStoreCoordinator.enqueueJob("VPN-" + vpnName,
-                new AddVpnInstanceWorker(idManager, vpnInterfaceManager, dataBroker, value));
+        jobCoordinator.enqueueJob("VPN-" + vpnName,
+            new AddVpnInstanceWorker(idManager, dataBroker, value));
     }
 
     private class AddVpnInstanceWorker implements Callable<List<ListenableFuture<Void>>> {
+        private final Logger log = LoggerFactory.getLogger(AddVpnInstanceWorker.class);
         IdManagerService idManager;
-        VpnInterfaceManager vpnInterfaceManager;
         VpnInstance vpnInstance;
         DataBroker broker;
 
-        public AddVpnInstanceWorker(IdManagerService idManager,
-                                    VpnInterfaceManager vpnInterfaceManager,
-                                    DataBroker broker,
-                                    VpnInstance value) {
+        AddVpnInstanceWorker(IdManagerService idManager,
+            DataBroker broker,
+            VpnInstance value) {
             this.idManager = idManager;
-            this.vpnInterfaceManager = vpnInterfaceManager;
             this.broker = broker;
             this.vpnInstance = value;
         }
@@ -341,112 +176,110 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
         public List<ListenableFuture<Void>> call() throws Exception {
             // If another renderer(for eg : CSS) needs to be supported, check can be performed here
             // to call the respective helpers.
-            final VpnAfConfig config = vpnInstance.getIpv4Family();
-            final String rd = config.getRouteDistinguisher();
             WriteTransaction writeConfigTxn = broker.newWriteOnlyTransaction();
             WriteTransaction writeOperTxn = broker.newWriteOnlyTransaction();
             addVpnInstance(vpnInstance, writeConfigTxn, writeOperTxn);
-            CheckedFuture<Void, TransactionCommitFailedException> checkFutures = writeOperTxn.submit();
             try {
-                checkFutures.get();
+                writeOperTxn.submit().get();
             } catch (InterruptedException | ExecutionException e) {
-                LOG.error("Error creating vpn {} ", vpnInstance.getVpnInstanceName());
+                log.error("{} call: Error creating vpn {} ", LOGGING_PREFIX_ADD, vpnInstance.getVpnInstanceName());
                 throw new RuntimeException(e.getMessage());
             }
             List<ListenableFuture<Void>> futures = new ArrayList<>();
             futures.add(writeConfigTxn.submit());
             ListenableFuture<List<Void>> listenableFuture = Futures.allAsList(futures);
-            if (rd != null) {
-                Futures.addCallback(listenableFuture,
-                        new AddBgpVrfWorker(config , vpnInstance.getVpnInstanceName()));
-            }
+            Futures.addCallback(listenableFuture,
+                                new PostAddVpnInstanceWorker(vpnInstance , vpnInstance.getVpnInstanceName()),
+                                MoreExecutors.directExecutor());
             return futures;
         }
     }
 
+    // TODO Clean up the exception handling
+    @SuppressWarnings("checkstyle:IllegalCatch")
     private void addVpnInstance(VpnInstance value, WriteTransaction writeConfigTxn,
-                                WriteTransaction writeOperTxn) {
+        WriteTransaction writeOperTxn) {
         VpnAfConfig config = value.getIpv4Family();
-        String rd = config.getRouteDistinguisher();
         String vpnInstanceName = value.getVpnInstanceName();
 
         long vpnId = VpnUtil.getUniqueId(idManager, VpnConstants.VPN_IDPOOL_NAME, vpnInstanceName);
         if (vpnId == 0) {
-            LOG.error("Unable to fetch label from Id Manager. Bailing out of adding operational data for Vpn Instance {}", value.getVpnInstanceName());
+            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;
         }
-        LOG.trace("VPN instance to ID generated.");
+        LOG.info("{} addVpnInstance: VPN Id {} generated for VpnInstanceName {}", LOGGING_PREFIX_ADD, vpnId,
+                vpnInstanceName);
+        String primaryRd = VpnUtil.getPrimaryRd(value);
         org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
-                vpnInstanceToVpnId = VpnUtil.getVpnInstanceToVpnId(vpnInstanceName, vpnId, (rd != null) ? rd
-                : vpnInstanceName);
+            vpnInstanceToVpnId = VpnUtil.getVpnInstanceToVpnId(vpnInstanceName, vpnId, primaryRd);
 
         if (writeConfigTxn != null) {
             writeConfigTxn.put(LogicalDatastoreType.CONFIGURATION,
-                    VpnUtil.getVpnInstanceToVpnIdIdentifier(vpnInstanceName),
-                    vpnInstanceToVpnId, true);
+                VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnInstanceName),
+                vpnInstanceToVpnId, WriteTransaction.CREATE_MISSING_PARENTS);
         } else {
-             TransactionUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION,
-                     VpnUtil.getVpnInstanceToVpnIdIdentifier(vpnInstanceName),
-                     vpnInstanceToVpnId, TransactionUtil.DEFAULT_CALLBACK);
+            TransactionUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION,
+                VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnInstanceName),
+                vpnInstanceToVpnId, TransactionUtil.DEFAULT_CALLBACK);
         }
 
         VpnIds vpnIdToVpnInstance = VpnUtil.getVpnIdToVpnInstance(vpnId, value.getVpnInstanceName(),
-                (rd != null) ? rd : value.getVpnInstanceName(), (rd != null)/*isExternalVpn*/);
+            primaryRd, VpnUtil.isBgpVpn(vpnInstanceName, primaryRd));
 
         if (writeConfigTxn != null) {
             writeConfigTxn.put(LogicalDatastoreType.CONFIGURATION,
-                    VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId),
-                    vpnIdToVpnInstance, true);
+                VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId),
+                vpnIdToVpnInstance, WriteTransaction.CREATE_MISSING_PARENTS);
         } else {
-             TransactionUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION,
-                     VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId),
-                     vpnIdToVpnInstance, TransactionUtil.DEFAULT_CALLBACK);
+            TransactionUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION,
+                VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId),
+                vpnIdToVpnInstance, TransactionUtil.DEFAULT_CALLBACK);
         }
 
         try {
             String cachedTransType = fibManager.getConfTransType();
-            LOG.trace("Value for confTransportType is " + cachedTransType);
             if (cachedTransType.equals("Invalid")) {
                 try {
                     fibManager.setConfTransType("L3VPN", "VXLAN");
                 } catch (Exception e) {
-                    LOG.trace("Exception caught setting the cached value for transportType");
-                    LOG.error(e.getMessage());
+                    LOG.error("{} addVpnInstance: Exception caught setting the L3VPN tunnel transportType for vpn {}",
+                            LOGGING_PREFIX_ADD, vpnInstanceName, e);
                 }
             } else {
-                LOG.trace(":cached val is neither unset/invalid. NO-op.");
+                LOG.debug("{} addVpnInstance: Configured tunnel transport type for L3VPN {} as {}", LOGGING_PREFIX_ADD,
+                        vpnInstanceName, cachedTransType);
             }
         } catch (Exception e) {
-            LOG.error(e.getMessage());
+            LOG.error("{} addVpnInstance: Error when trying to retrieve tunnel transport type for L3VPN {}",
+                    LOGGING_PREFIX_ADD, vpnInstanceName, e);
         }
 
-        if (rd == null) {
-            VpnInstanceOpDataEntryBuilder builder =
-                    new VpnInstanceOpDataEntryBuilder().setVrfId(vpnInstanceName).setVpnId(vpnId)
-                            .setVpnInstanceName(vpnInstanceName);
-            if (writeOperTxn != null) {
-                writeOperTxn.merge(LogicalDatastoreType.OPERATIONAL,
-                        VpnUtil.getVpnInstanceOpDataIdentifier(vpnInstanceName),
-                        builder.build(), true);
-            } else {
-                 TransactionUtil.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL,
-                         VpnUtil.getVpnInstanceOpDataIdentifier(vpnInstanceName),
-                         builder.build(), TransactionUtil.DEFAULT_CALLBACK);
+        VpnInstanceOpDataEntryBuilder builder =
+                new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd).setVpnId(vpnId)
+                        .setVpnInstanceName(vpnInstanceName)
+                        .setVpnState(VpnInstanceOpDataEntry.VpnState.Created)
+                        .setIpv4Configured(false).setIpv6Configured(false);
+        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<>();
+            if (value.getL3vni() != null) {
+                builder.setL3vni(value.getL3vni());
+            }
+            if (value.getType() == VpnInstance.Type.L2) {
+                builder.setType(VpnInstanceOpDataEntry.Type.L2);
             }
-        } else {
-            VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder()
-                    .setVrfId(rd).setVpnId(vpnId).setVpnInstanceName(vpnInstanceName);
-
-            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<>();
             VpnTargets vpnTargets = config.getVpnTargets();
             if (vpnTargets != null) {
                 List<VpnTarget> vpnTargetList = vpnTargets.getVpnTarget();
                 if (vpnTargetList != null) {
                     for (VpnTarget vpnTarget : vpnTargetList) {
-                        VpnTargetBuilder vpnTargetBuilder = new VpnTargetBuilder().setKey(new VpnTargetKey(vpnTarget.getKey().getVrfRTValue()))
-                                        .setVrfRTType(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
-                                                .instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget.VrfRTType
-                                                .forValue(vpnTarget.getVrfRTType().getIntValue())).setVrfRTValue(vpnTarget.getVrfRTValue());
+                        VpnTargetBuilder vpnTargetBuilder =
+                            new VpnTargetBuilder().setKey(new VpnTargetKey(vpnTarget.getKey().getVrfRTValue()))
+                                .setVrfRTType(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
+                                    .instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget.VrfRTType
+                                    .forValue(vpnTarget.getVrfRTType().getIntValue())).setVrfRTValue(
+                                vpnTarget.getVrfRTValue());
                         opVpnTargetList.add(vpnTargetBuilder.build());
                     }
                 }
@@ -454,66 +287,104 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
             VpnTargetsBuilder vpnTargetsBuilder = new VpnTargetsBuilder().setVpnTarget(opVpnTargetList);
             builder.setVpnTargets(vpnTargetsBuilder.build());
 
-            if (writeOperTxn != null) {
-                writeOperTxn.merge(LogicalDatastoreType.OPERATIONAL,
-                        VpnUtil.getVpnInstanceOpDataIdentifier(rd),
-                        builder.build(), true);
-            } else {
-                 TransactionUtil.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL,
-                        VpnUtil.getVpnInstanceOpDataIdentifier(rd),
-                        builder.build(), TransactionUtil.DEFAULT_CALLBACK);
-            }
+            List<String> rds = config.getRouteDistinguisher();
+            builder.setRd(rds);
         }
+        if (writeOperTxn != null) {
+            writeOperTxn.merge(LogicalDatastoreType.OPERATIONAL,
+                VpnUtil.getVpnInstanceOpDataIdentifier(primaryRd),
+                builder.build(), true);
+        } else {
+            TransactionUtil.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL,
+                VpnUtil.getVpnInstanceOpDataIdentifier(primaryRd),
+                builder.build(), TransactionUtil.DEFAULT_CALLBACK);
+        }
+        LOG.info("{} addVpnInstance: VpnInstanceOpData populated successfully for vpn {} rd {}", LOGGING_PREFIX_ADD,
+                vpnInstanceName, primaryRd);
     }
 
-
-    private class AddBgpVrfWorker implements FutureCallback<List<Void>> {
-        VpnAfConfig config;
+    private class PostAddVpnInstanceWorker implements FutureCallback<List<Void>> {
+        private final Logger log = LoggerFactory.getLogger(PostAddVpnInstanceWorker.class);
+        VpnInstance vpnInstance;
         String vpnName;
 
-        public AddBgpVrfWorker(VpnAfConfig config, String vpnName)  {
-            this.config = config;
+        PostAddVpnInstanceWorker(VpnInstance vpnInstance, String vpnName) {
+            this.vpnInstance = vpnInstance;
             this.vpnName = vpnName;
         }
 
         /**
-         * @param voids
          * This implies that all the future instances have returned success. -- TODO: Confirm this
          */
         @Override
         public void onSuccess(List<Void> voids) {
-            String rd = config.getRouteDistinguisher();
-            if (rd != null) {
-                List<VpnTarget> vpnTargetList = config.getVpnTargets().getVpnTarget();
-
-                List<String> ertList = new ArrayList<String>();
-                List<String> irtList = new ArrayList<String>();
-
-                for (VpnTarget vpnTarget : vpnTargetList) {
-                    if (vpnTarget.getVrfRTType() == VpnTarget.VrfRTType.ExportExtcommunity) {
-                        ertList.add(vpnTarget.getVrfRTValue());
-                    }
-                    if (vpnTarget.getVrfRTType() == VpnTarget.VrfRTType.ImportExtcommunity) {
-                        irtList.add(vpnTarget.getVrfRTValue());
-                    }
-                    if (vpnTarget.getVrfRTType() == VpnTarget.VrfRTType.Both) {
-                        ertList.add(vpnTarget.getVrfRTValue());
-                        irtList.add(vpnTarget.getVrfRTValue());
-                    }
+            /*
+            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();
+            if (rd == null || addBgpVrf(voids)) {
+                notifyTask();
+                vpnInterfaceManager.vpnInstanceIsReady(vpnName);
+            }
+            log.info("{} onSuccess: Vpn Instance Op Data addition for {} successful.", LOGGING_PREFIX_ADD, vpnName);
+            VpnInstanceOpDataEntry vpnInstanceOpDataEntry = VpnUtil.getVpnInstanceOpData(dataBroker,
+                    VpnUtil.getPrimaryRd(vpnInstance));
+
+            // bind service on each tunnel interface
+            //TODO (KIRAN): Add a new listener to handle creation of new DC-GW binding and deletion of existing DC-GW.
+            if (VpnUtil.isL3VpnOverVxLan(vpnInstance.getL3vni())) { //Handled for L3VPN Over VxLAN
+                for (String tunnelInterfaceName: getDcGatewayTunnelInterfaceNameList()) {
+                    VpnUtil.bindService(vpnInstance.getVpnInstanceName(), tunnelInterfaceName, dataBroker,
+                            true/*isTunnelInterface*/, jobCoordinator);
                 }
 
-                try {
-                    bgpManager.addVrf(rd, irtList, ertList);
-                } catch (Exception e) {
-                    LOG.error("Exception when adding VRF to BGP", e);
-                    return;
+                // install flow
+                List<MatchInfo> mkMatches = new ArrayList<>();
+                mkMatches.add(new MatchTunnelId(BigInteger.valueOf(vpnInstance.getL3vni())));
+
+                List<InstructionInfo> instructions =
+                        Arrays.asList(new InstructionWriteMetadata(MetaDataUtil.getVpnIdMetadata(vpnInstanceOpDataEntry
+                                .getVpnId()), 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);
                 }
-                vpnInterfaceManager.handleVpnsExportingRoutes(this.vpnName, rd);
+
+                ///////////////////////
             }
         }
+
+        // TODO Clean up the exception handling
+        @SuppressWarnings("checkstyle:IllegalCatch")
+        private boolean addBgpVrf(List<Void> voids) {
+            VpnAfConfig config = vpnInstance.getIpv4Family();
+            String primaryRd = VpnUtil.getPrimaryRd(dataBroker, vpnName);
+            List<VpnTarget> vpnTargetList = config.getVpnTargets().getVpnTarget();
+
+            if (vpnTargetList == null) {
+                log.error("{} addBgpVrf: vpn target list is empty for vpn {} RD {}", LOGGING_PREFIX_ADD,
+                        this.vpnName, primaryRd);
+                return false;
+            }
+            vpnInterfaceManager.handleVpnsExportingRoutes(this.vpnName, primaryRd);
+            return true;
+        }
+
+        private void notifyTask() {
+            vpnOpDataNotifier.notifyVpnOpDataReady(VpnOpDataSyncer.VpnOpDataType.vpnInstanceToId, vpnName);
+            vpnOpDataNotifier.notifyVpnOpDataReady(VpnOpDataSyncer.VpnOpDataType.vpnOpData, vpnName);
+        }
+
         /**
-         *
-         * @param throwable
          * This method is used to handle failure callbacks.
          * If more retry needed, the retrycount is decremented and mainworker is executed again.
          * After retries completed, rollbackworker is executed.
@@ -522,33 +393,78 @@ public class VpnInstanceListener extends AsyncDataTreeChangeListenerBase<VpnInst
 
         @Override
         public void onFailure(Throwable throwable) {
-            LOG.warn("Job: failed with exception: {}", throwable.getStackTrace());
+            log.error("{} onFailure: Job for vpnInstance: {} failed with exception: {}", LOGGING_PREFIX_ADD, vpnName,
+                    throwable);
+            vpnInterfaceManager.vpnInstanceFailed(vpnName);
         }
     }
 
-    public boolean isVPNConfigured() {
-
-        InstanceIdentifier<VpnInstances> vpnsIdentifier =
-                InstanceIdentifier.builder(VpnInstances.class).build();
-        Optional<VpnInstances> optionalVpns = TransactionUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
-                vpnsIdentifier);
-        if (!optionalVpns.isPresent() ||
-                optionalVpns.get().getVpnInstance() == null ||
-                optionalVpns.get().getVpnInstance().isEmpty()) {
-            LOG.trace("No VPNs configured.");
-            return false;
-        }
-        LOG.trace("VPNs are configured on the system.");
-        return true;
-    }
-
     protected VpnInstanceOpDataEntry getVpnInstanceOpData(String rd) {
         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
         Optional<VpnInstanceOpDataEntry> vpnInstanceOpData =
-                TransactionUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
-        if(vpnInstanceOpData.isPresent()) {
+            TransactionUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
+        if (vpnInstanceOpData.isPresent()) {
             return vpnInstanceOpData.get();
         }
         return null;
     }
+
+    private List<String> getDcGatewayTunnelInterfaceNameList() {
+        List<String> tunnelInterfaceNameList = new ArrayList<>();
+
+        InstanceIdentifier<DcGatewayIpList> dcGatewayIpListInstanceIdentifier = InstanceIdentifier
+                .create(DcGatewayIpList.class);
+        Optional<DcGatewayIpList> dcGatewayIpListOptional = VpnUtil.read(dataBroker,
+                LogicalDatastoreType.CONFIGURATION, dcGatewayIpListInstanceIdentifier);
+        if (!dcGatewayIpListOptional.isPresent()) {
+            LOG.info("No DC gateways configured.");
+            return tunnelInterfaceNameList;
+        }
+        List<DcGatewayIp> dcGatewayIps = dcGatewayIpListOptional.get().getDcGatewayIp();
+
+        InstanceIdentifier<ExternalTunnelList> externalTunnelListId = InstanceIdentifier
+                .create(ExternalTunnelList.class);
+
+        Optional<ExternalTunnelList> externalTunnelListOptional = VpnUtil.read(dataBroker,
+                LogicalDatastoreType.OPERATIONAL, externalTunnelListId);
+        if (externalTunnelListOptional.isPresent()) {
+            List<ExternalTunnel> externalTunnels = externalTunnelListOptional.get().getExternalTunnel();
+
+            List<String> externalTunnelIpList = new ArrayList<>();
+            for (ExternalTunnel externalTunnel: externalTunnels) {
+                externalTunnelIpList.add(externalTunnel.getDestinationDevice());
+            }
+
+            List<String> dcGatewayIpList = new ArrayList<>();
+            for (DcGatewayIp dcGatewayIp: dcGatewayIps) {
+                dcGatewayIpList.add(dcGatewayIp.getIpAddress().getIpv4Address().toString());
+            }
+
+            // Find all externalTunnelIps present in dcGateWayIpList
+            List<String> externalTunnelIpsInDcGatewayIpList = new ArrayList<>();
+            for (String externalTunnelIp: externalTunnelIpList) {
+                for (String dcGateWayIp: dcGatewayIpList) {
+                    if (externalTunnelIp.contentEquals(dcGateWayIp)) {
+                        externalTunnelIpsInDcGatewayIpList.add(externalTunnelIp);
+                    }
+                }
+            }
+
+
+            for (String externalTunnelIpsInDcGatewayIp: externalTunnelIpsInDcGatewayIpList) {
+                for (ExternalTunnel externalTunnel: externalTunnels) {
+                    if (externalTunnel.getDestinationDevice().contentEquals(externalTunnelIpsInDcGatewayIp)) {
+                        tunnelInterfaceNameList.add(externalTunnel.getTunnelInterfaceName());
+                    }
+                }
+            }
+
+        }
+        return tunnelInterfaceNameList;
+    }
+
+    private String getFibFlowRef(BigInteger dpnId, short tableId, String vpnName, int priority) {
+        return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
+                + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
+    }
 }