neutronvpn/impl/src/main/java/org/opendaylight/netvirt/neutronvpn/NeutronvpnUtils.java

   1 /*
   2  * Copyright (c) 2016, 2018 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.netvirt.neutronvpn;
  10
  11 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
  12 import static org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils.requireNonNullElse;
  13
  14 import com.google.common.base.Optional;
  15 import com.google.common.collect.ImmutableBiMap;
  16 import com.google.common.collect.Sets;
  17 import java.math.BigInteger;
  18 import java.net.Inet4Address;
  19 import java.net.Inet6Address;
  20 import java.net.InetAddress;
  21 import java.net.UnknownHostException;
  22 import java.util.ArrayList;
  23 import java.util.Collection;
  24 import java.util.Collections;
  25 import java.util.HashMap;
  26 import java.util.HashSet;
  27 import java.util.Iterator;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Set;
  31 import java.util.concurrent.ConcurrentHashMap;
  32 import java.util.concurrent.ConcurrentMap;
  33 import java.util.concurrent.ExecutionException;
  34 import java.util.concurrent.Future;
  35 import java.util.stream.Collectors;
  36 import javax.annotation.Nonnull;
  37 import javax.annotation.Nullable;
  38 import javax.inject.Inject;
  39 import javax.inject.Singleton;
  40 import org.apache.commons.lang3.StringUtils;
  41 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  42 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  43 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  44 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  45 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  46 import org.opendaylight.genius.infra.Datastore;
  47 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  48 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  49 import org.opendaylight.genius.infra.TypedWriteTransaction;
  50 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  51 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  52 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
  53 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
  54 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
  55 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  56 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  57 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  58 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
  59 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  60 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.Dhcpv6Base;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpVersionBase;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.PortSubnets;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnet;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnetBuilder;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnetKey;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfo;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfoBuilder;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfoKey;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnListKey;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnMaps;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIds;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIdsBuilder;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMap;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMapKey;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router.ExternalGatewayInfo;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
 137 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
 138 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
 139 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
 140 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
 141 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
 142 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
 143 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
 144 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
 145 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
 146 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 147 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
 148 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.portsecurity.rev150712.PortSecurityExtension;
 149 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
 150 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.QosPolicy;
 151 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
 152 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
 153 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
 154 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
 155 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinkStates;
 156 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinks;
 157 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
 158 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateKey;
 159 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
 160 import org.opendaylight.yangtools.yang.binding.DataObject;
 161 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 162 import org.opendaylight.yangtools.yang.common.RpcResult;
 163 import org.slf4j.Logger;
 164 import org.slf4j.LoggerFactory;
 165
 166 @Singleton
 167 public class NeutronvpnUtils {
 168
 169     private static final Logger LOG = LoggerFactory.getLogger(NeutronvpnUtils.class);
 170     private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>
 171         NETWORK_MAP =
 172         new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
 173             .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
 174             .put(NetworkTypeGre.class, SegmentTypeGre.class)
 175             .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
 176             .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
 177             .build();
 178
 179     private static final Set<Class<? extends NetworkTypeBase>> SUPPORTED_NETWORK_TYPES = new HashSet<>();
 180
 181     static {
 182         SUPPORTED_NETWORK_TYPES.add(NetworkTypeFlat.class);
 183         SUPPORTED_NETWORK_TYPES.add(NetworkTypeVlan.class);
 184         SUPPORTED_NETWORK_TYPES.add(NetworkTypeVxlan.class);
 185         SUPPORTED_NETWORK_TYPES.add(NetworkTypeGre.class);
 186     }
 187
 188     private final ConcurrentMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
 189     private final ConcurrentMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
 190     private final ConcurrentMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
 191     private final ConcurrentMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
 192     private final Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
 193     private final ConcurrentMap<Uuid, QosPolicy> qosPolicyMap = new ConcurrentHashMap<>();
 194     private final ConcurrentMap<Uuid, HashMap<Uuid, Port>> qosPortsMap = new ConcurrentHashMap<>();
 195     private final ConcurrentMap<Uuid, HashMap<Uuid, Network>> qosNetworksMap = new ConcurrentHashMap<>();
 196
 197     private final DataBroker dataBroker;
 198     private final ManagedNewTransactionRunner txRunner;
 199     private final IdManagerService idManager;
 200     private final JobCoordinator jobCoordinator;
 201     private final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt;
 202
 203     @Inject
 204     public NeutronvpnUtils(final DataBroker dataBroker, final IdManagerService idManager,
 205             final JobCoordinator jobCoordinator, final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt) {
 206         this.dataBroker = dataBroker;
 207         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
 208         this.idManager = idManager;
 209         this.jobCoordinator = jobCoordinator;
 210         this.ipV6InternetDefRt = ipV6InternetDefRt;
 211     }
 212
 213     @Nullable
 214     protected Subnetmap getSubnetmap(Uuid subnetId) {
 215         InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
 216         Optional<Subnetmap> sn = read(LogicalDatastoreType.CONFIGURATION, id);
 217
 218         if (sn.isPresent()) {
 219             return sn.get();
 220         }
 221         LOG.error("getSubnetmap failed, subnet {} is not present", subnetId.getValue());
 222         return null;
 223     }
 224
 225     @Nullable
 226     public VpnMap getVpnMap(Uuid id) {
 227         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 228                 new VpnMapKey(id)).build();
 229         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 230         if (optionalVpnMap.isPresent()) {
 231             return optionalVpnMap.get();
 232         }
 233         LOG.error("getVpnMap failed, VPN {} not present", id.getValue());
 234         return null;
 235     }
 236
 237     @Nullable
 238     protected Uuid getVpnForNetwork(Uuid network) {
 239         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 240         Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
 241         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 242             for (VpnMap vpnMap : requireNonNullElse(optionalVpnMaps.get().getVpnMap(),
 243                     Collections.<VpnMap>emptyList())) {
 244                 List<Uuid> netIds = vpnMap.getNetworkIds();
 245                 if (netIds != null && netIds.contains(network)) {
 246                     return vpnMap.getVpnId();
 247                 }
 248             }
 249         }
 250         LOG.debug("getVpnForNetwork: Failed for network {} as no VPN present in VPNMaps DS", network.getValue());
 251         return null;
 252     }
 253
 254     @Nullable
 255     protected Uuid getVpnForSubnet(Uuid subnetId) {
 256         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 257         Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
 258                 subnetmapIdentifier);
 259         if (optionalSubnetMap.isPresent()) {
 260             return optionalSubnetMap.get().getVpnId();
 261         }
 262         LOG.error("getVpnForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
 263         return null;
 264     }
 265
 266     @Nullable
 267     protected Uuid getNetworkForSubnet(Uuid subnetId) {
 268         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 269         Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
 270                 subnetmapIdentifier);
 271         if (optionalSubnetMap.isPresent()) {
 272             return optionalSubnetMap.get().getNetworkId();
 273         }
 274         LOG.error("getNetworkForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
 275         return null;
 276     }
 277
 278     // @param external vpn - true if external vpn being fetched, false for internal vpn
 279     @Nullable
 280     protected Uuid getVpnForRouter(@Nullable Uuid routerId, boolean externalVpn) {
 281         if (routerId == null) {
 282             return null;
 283         }
 284
 285         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 286         Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
 287         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 288             for (VpnMap vpnMap : requireNonNullElse(optionalVpnMaps.get().getVpnMap(),
 289                     Collections.<VpnMap>emptyList())) {
 290                 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.vpnmap
 291                     .RouterIds> routerIdsList = vpnMap.getRouterIds();
 292                 if (routerIdsList == null || routerIdsList.isEmpty()) {
 293                     continue;
 294                 }
 295                 // Skip router vpnId fetching from internet BGP-VPN
 296                 if (vpnMap.getNetworkIds() != null && !vpnMap.getNetworkIds().isEmpty()) {
 297                     // We only need to check the first network; if it’s not an external network there’s no
 298                     // need to check the rest of the VPN’s network list
 299                     if (getIsExternal(getNeutronNetwork(vpnMap.getNetworkIds().iterator().next()))) {
 300                         continue;
 301                     }
 302                 }
 303                 // FIXME: NETVIRT-1503: this check can be replaced by a ReadOnlyTransaction.exists()
 304                 if (routerIdsList.stream().anyMatch(routerIds -> routerId.equals(routerIds.getRouterId()))) {
 305                     if (externalVpn) {
 306                         if (!routerId.equals(vpnMap.getVpnId())) {
 307                             return vpnMap.getVpnId();
 308                         }
 309                     } else {
 310                         if (routerId.equals(vpnMap.getVpnId())) {
 311                             return vpnMap.getVpnId();
 312                         }
 313                     }
 314                 }
 315             }
 316         }
 317         LOG.debug("getVpnForRouter: Failed for router {} as no VPN present in VPNMaps DS", routerId.getValue());
 318         return null;
 319     }
 320
 321     @Nullable
 322     protected List<Uuid> getRouterIdListforVpn(Uuid vpnId) {
 323         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 324                 new VpnMapKey(vpnId)).build();
 325         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 326         if (optionalVpnMap.isPresent()) {
 327             VpnMap vpnMap = optionalVpnMap.get();
 328             return NeutronUtils.getVpnMapRouterIdsListUuid(vpnMap.getRouterIds());
 329         }
 330         LOG.error("getRouterIdListforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
 331         return null;
 332     }
 333
 334     @Nullable
 335     protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
 336         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 337                 new VpnMapKey(vpnId)).build();
 338         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 339         if (optionalVpnMap.isPresent()) {
 340             VpnMap vpnMap = optionalVpnMap.get();
 341             return vpnMap.getNetworkIds();
 342         }
 343         LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
 344         return null;
 345     }
 346
 347     protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
 348         List<Uuid> subnets = new ArrayList<>();
 349         // read subnetmaps
 350         InstanceIdentifier<Subnetmaps> subnetmapsid = InstanceIdentifier.builder(Subnetmaps.class).build();
 351         Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, subnetmapsid);
 352         if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
 353             List<Subnetmap> subnetMapList = subnetmaps.get().getSubnetmap();
 354             for (Subnetmap candidateSubnetMap : subnetMapList) {
 355                 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
 356                     subnets.add(candidateSubnetMap.getId());
 357                 }
 358             }
 359         }
 360         return subnets;
 361     }
 362
 363     @Nullable
 364     protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
 365         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 366         Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
 367         if (vpnPortipToPortData.isPresent()) {
 368             return vpnPortipToPortData.get().getPortName();
 369         }
 370         LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
 371                 + " fixed IP {}", vpnName, fixedIp);
 372         return null;
 373     }
 374
 375     @Nullable
 376     protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
 377         InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
 378         Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
 379         if (optionalNetworkMap.isPresent()) {
 380             return optionalNetworkMap.get().getSubnetIdList();
 381         }
 382         LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
 383         return null;
 384     }
 385
 386     @Nullable
 387     protected List<Uuid> getPortIdsFromSubnetId(Uuid subnetId) {
 388         InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
 389         Optional<Subnetmap> optionalSubnetmap = read(LogicalDatastoreType.CONFIGURATION, id);
 390         if (optionalSubnetmap.isPresent()) {
 391             return optionalSubnetmap.get().getPortList();
 392         }
 393         return null;
 394     }
 395
 396     protected Router getNeutronRouter(Uuid routerId) {
 397         Router router = routerMap.get(routerId);
 398         if (router != null) {
 399             return router;
 400         }
 401         InstanceIdentifier<Router> inst = InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
 402                 .class, new RouterKey(routerId));
 403         Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, inst);
 404         if (rtr.isPresent()) {
 405             router = rtr.get();
 406         }
 407         return router;
 408     }
 409
 410     public InstanceIdentifier<Router> getNeutronRouterIid(Uuid routerId) {
 411         return InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
 412                 .class, new RouterKey(routerId));
 413
 414     }
 415
 416     protected Network getNeutronNetwork(Uuid networkId) {
 417         Network network = null;
 418         network = networkMap.get(networkId);
 419         if (network != null) {
 420             return network;
 421         }
 422         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
 423         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(Networks.class)
 424             .child(Network.class, new NetworkKey(networkId));
 425         Optional<Network> net = read(LogicalDatastoreType.CONFIGURATION, inst);
 426         if (net.isPresent()) {
 427             network = net.get();
 428         }
 429         return network;
 430     }
 431
 432     protected Port getNeutronPort(Uuid portId) {
 433         Port prt = portMap.get(portId);
 434         if (prt != null) {
 435             return prt;
 436         }
 437         LOG.debug("getNeutronPort for {}", portId.getValue());
 438         InstanceIdentifier<Port> inst = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(Port.class,
 439                 new PortKey(portId));
 440         Optional<Port> port = read(LogicalDatastoreType.CONFIGURATION, inst);
 441         if (port.isPresent()) {
 442             prt = port.get();
 443         }
 444         return prt;
 445     }
 446
 447     /**
 448      * Returns port_security_enabled status with the port.
 449      *
 450      * @param port the port
 451      * @return port_security_enabled status
 452      */
 453     protected static boolean getPortSecurityEnabled(Port port) {
 454         String deviceOwner = port.getDeviceOwner();
 455         if (deviceOwner != null && deviceOwner.startsWith("network:")) {
 456             // port with device owner of network:xxx is created by
 457             // neutorn for its internal use. So security group doesn't apply.
 458             // router interface, dhcp port and floating ip.
 459             return false;
 460         }
 461         PortSecurityExtension portSecurity = port.augmentation(PortSecurityExtension.class);
 462         if (portSecurity != null) {
 463             return portSecurity.isPortSecurityEnabled();
 464         }
 465         return false;
 466     }
 467
 468     /**
 469      * Gets security group UUIDs delta   .
 470      *
 471      * @param port1SecurityGroups the port 1 security groups
 472      * @param port2SecurityGroups the port 2 security groups
 473      * @return the security groups delta
 474      */
 475     @Nullable
 476     protected static List<Uuid> getSecurityGroupsDelta(@Nullable List<Uuid> port1SecurityGroups,
 477             @Nullable List<Uuid> port2SecurityGroups) {
 478         if (port1SecurityGroups == null) {
 479             return null;
 480         }
 481
 482         if (port2SecurityGroups == null) {
 483             return port1SecurityGroups;
 484         }
 485
 486         List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
 487         List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
 488         for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
 489             Uuid securityGroup1 = iterator.next();
 490             for (Uuid securityGroup2 : list2) {
 491                 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
 492                     iterator.remove();
 493                     break;
 494                 }
 495             }
 496         }
 497         return list1;
 498     }
 499
 500     /**
 501      * Gets the fixed ips delta.
 502      *
 503      * @param port1FixedIps the port 1 fixed ips
 504      * @param port2FixedIps the port 2 fixed ips
 505      * @return the fixed ips delta
 506      */
 507     protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
 508         if (port1FixedIps == null) {
 509             return null;
 510         }
 511
 512         if (port2FixedIps == null) {
 513             return port1FixedIps;
 514         }
 515
 516         List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
 517         List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
 518         for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
 519             FixedIps fixedIps1 = iterator.next();
 520             for (FixedIps fixedIps2 : list2) {
 521                 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
 522                     iterator.remove();
 523                     break;
 524                 }
 525             }
 526         }
 527         return list1;
 528     }
 529
 530     /**
 531      * Gets the allowed address pairs delta.
 532      *
 533      * @param port1AllowedAddressPairs the port 1 allowed address pairs
 534      * @param port2AllowedAddressPairs the port 2 allowed address pairs
 535      * @return the allowed address pairs delta
 536      */
 537     @Nullable
 538     protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
 539         @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 540             .AllowedAddressPairs> port1AllowedAddressPairs,
 541         @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 542             .AllowedAddressPairs> port2AllowedAddressPairs) {
 543         if (port1AllowedAddressPairs == null) {
 544             return null;
 545         }
 546
 547         if (port2AllowedAddressPairs == null) {
 548             return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
 549         }
 550
 551         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 552             .AllowedAddressPairs> list1 =
 553                 new ArrayList<>(port1AllowedAddressPairs);
 554         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 555             .AllowedAddressPairs> list2 =
 556                 new ArrayList<>(port2AllowedAddressPairs);
 557         for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 558             .AllowedAddressPairs> iterator =
 559              list1.iterator(); iterator.hasNext();) {
 560             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 561                 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
 562             for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 563                      .AllowedAddressPairs allowedAddressPair2 : list2) {
 564                 if (allowedAddressPair1.key().equals(allowedAddressPair2.key())) {
 565                     iterator.remove();
 566                     break;
 567                 }
 568             }
 569         }
 570         return getAllowedAddressPairsForAclService(list1);
 571     }
 572
 573     /**
 574      * Gets the acl allowed address pairs.
 575      *
 576      * @param macAddress the mac address
 577      * @param ipAddress the ip address
 578      * @return the acl allowed address pairs
 579      */
 580     protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
 581             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
 582         AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
 583         aclAllowedAdressPairBuilder.setMacAddress(macAddress);
 584         if (ipAddress != null && ipAddress.stringValue() != null) {
 585             if (ipAddress.getIpPrefix() != null) {
 586                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
 587             } else {
 588                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
 589             }
 590         }
 591         return aclAllowedAdressPairBuilder.build();
 592     }
 593
 594     /**
 595      * Gets the allowed address pairs for acl service.
 596      *
 597      * @param macAddress the mac address
 598      * @param fixedIps the fixed ips
 599      * @return the allowed address pairs for acl service
 600      */
 601     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
 602             List<FixedIps> fixedIps) {
 603         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 604         for (FixedIps fixedIp : fixedIps) {
 605             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
 606                     org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
 607                     .getDefaultInstance(fixedIp.getIpAddress().stringValue())));
 608         }
 609         return aclAllowedAddressPairs;
 610     }
 611
 612     /**
 613      * Gets the allowed address pairs for acl service.
 614      *
 615      * @param portAllowedAddressPairs the port allowed address pairs
 616      * @return the allowed address pairs for acl service
 617      */
 618     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
 619         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 620             .AllowedAddressPairs> portAllowedAddressPairs) {
 621         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 622         for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
 623                  portAllowedAddressPair : portAllowedAddressPairs) {
 624             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
 625                 portAllowedAddressPair.getIpAddress()));
 626         }
 627         return aclAllowedAddressPairs;
 628     }
 629
 630     /**
 631      * Gets the IPv6 Link Local Address corresponding to the MAC Address.
 632      *
 633      * @param macAddress the mac address
 634      * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
 635      */
 636     protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
 637         IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
 638         return getAclAllowedAddressPairs(macAddress,
 639                 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
 640                 .getDefaultInstance(
 641                         ipv6LinkLocalAddress.stringValue()));
 642     }
 643
 644     /**
 645      * Gets the updated security groups.
 646      *
 647      * @param aclInterfaceSecurityGroups the acl interface security groups
 648      * @param origSecurityGroups the orig security groups
 649      * @param newSecurityGroups the new security groups
 650      * @return the updated security groups
 651      */
 652     protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
 653             List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
 654         List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
 655         List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
 656         List<Uuid> updatedSecurityGroups =
 657                 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
 658         if (addedGroups != null) {
 659             updatedSecurityGroups.addAll(addedGroups);
 660         }
 661         if (deletedGroups != null) {
 662             updatedSecurityGroups.removeAll(deletedGroups);
 663         }
 664         return updatedSecurityGroups;
 665     }
 666
 667     /**
 668      * Gets the allowed address pairs for fixed ips.
 669      *
 670      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 671      * @param portMacAddress the port mac address
 672      * @param origFixedIps the orig fixed ips
 673      * @param newFixedIps the new fixed ips
 674      * @return the allowed address pairs for fixed ips
 675      */
 676     protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
 677             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
 678             List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
 679         List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
 680         List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
 681         List<AllowedAddressPairs> updatedAllowedAddressPairs =
 682             aclInterfaceAllowedAddressPairs != null
 683                 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 684         if (deletedFixedIps != null) {
 685             updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
 686         }
 687         if (addedFixedIps != null) {
 688             updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
 689         }
 690         return updatedAllowedAddressPairs;
 691     }
 692
 693     /**
 694      * Gets the updated allowed address pairs.
 695      *
 696      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 697      * @param origAllowedAddressPairs the orig allowed address pairs
 698      * @param newAllowedAddressPairs the new allowed address pairs
 699      * @return the updated allowed address pairs
 700      */
 701     protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
 702             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
 703             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 704                 .AllowedAddressPairs> origAllowedAddressPairs,
 705             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 706                 .AllowedAddressPairs> newAllowedAddressPairs) {
 707         List<AllowedAddressPairs> addedAllowedAddressPairs =
 708             getAllowedAddressPairsDelta(newAllowedAddressPairs,origAllowedAddressPairs);
 709         List<AllowedAddressPairs> deletedAllowedAddressPairs =
 710             getAllowedAddressPairsDelta(origAllowedAddressPairs, newAllowedAddressPairs);
 711         List<AllowedAddressPairs> updatedAllowedAddressPairs =
 712             aclInterfaceAllowedAddressPairs != null
 713                 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 714         if (addedAllowedAddressPairs != null) {
 715             updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
 716         }
 717         if (deletedAllowedAddressPairs != null) {
 718             updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
 719         }
 720         return updatedAllowedAddressPairs;
 721     }
 722
 723     /**
 724      * Populate interface acl builder.
 725      *
 726      * @param interfaceAclBuilder the interface acl builder
 727      * @param port the port
 728      */
 729     protected static void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
 730         // Handle security group enabled
 731         List<Uuid> securityGroups = port.getSecurityGroups();
 732         if (securityGroups != null) {
 733             interfaceAclBuilder.setSecurityGroups(securityGroups);
 734         }
 735         List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
 736                 port.getMacAddress(), port.getFixedIps());
 737         // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
 738         aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
 739         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
 740             portAllowedAddressPairs = port.getAllowedAddressPairs();
 741         if (portAllowedAddressPairs != null) {
 742             aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
 743         }
 744         interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
 745     }
 746
 747     protected void populateSubnetInfo(Port port) {
 748         List<SubnetInfo> portSubnetInfo = getSubnetInfo(port);
 749         if (portSubnetInfo != null) {
 750             String portId = port.getUuid().getValue();
 751             InstanceIdentifier<PortSubnet> portSubnetIdentifier = buildPortSubnetIdentifier(portId);
 752
 753             PortSubnetBuilder portSubnetBuilder = new PortSubnetBuilder().withKey(new PortSubnetKey(portId))
 754                     .setPortId(portId).setSubnetInfo(portSubnetInfo);
 755             try {
 756                 SingleTransactionDataBroker.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL,
 757                         portSubnetIdentifier, portSubnetBuilder.build());
 758             } catch (TransactionCommitFailedException e) {
 759                 LOG.error("Failed to populate subnet info for port={}", portId, e);
 760             }
 761             LOG.debug("Created Subnet info for port={}", portId);
 762         }
 763     }
 764
 765     @Nullable
 766     protected List<SubnetInfo> getSubnetInfo(Port port) {
 767         List<FixedIps> portFixedIps = port.getFixedIps();
 768         if (portFixedIps == null) {
 769             LOG.error("Failed to get Fixed IPs for the port {}", port.getName());
 770             return null;
 771         }
 772         List<SubnetInfo> subnetInfoList = new ArrayList<>();
 773         for (FixedIps portFixedIp : portFixedIps) {
 774             Uuid subnetId = portFixedIp.getSubnetId();
 775             Subnet subnet = getNeutronSubnet(subnetId);
 776             if (subnet != null) {
 777                 Class<? extends IpVersionBase> ipVersion =
 778                         NeutronSecurityRuleConstants.IP_VERSION_MAP.get(subnet.getIpVersion());
 779                 Class<? extends Dhcpv6Base> raMode = subnet.getIpv6RaMode() == null ? null
 780                         : NeutronSecurityRuleConstants.RA_MODE_MAP.get(subnet.getIpv6RaMode());
 781                 SubnetInfo subnetInfo = new SubnetInfoBuilder().withKey(new SubnetInfoKey(subnetId))
 782                         .setIpVersion(ipVersion).setIpPrefix(new IpPrefixOrAddress(subnet.getCidr()))
 783                         .setIpv6RaMode(raMode).setGatewayIp(subnet.getGatewayIp()).build();
 784                 subnetInfoList.add(subnetInfo);
 785             }
 786         }
 787         return subnetInfoList;
 788     }
 789
 790     protected Subnet getNeutronSubnet(Uuid subnetId) {
 791         Subnet subnet = subnetMap.get(subnetId);
 792         if (subnet != null) {
 793             return subnet;
 794         }
 795         InstanceIdentifier<Subnet> inst = InstanceIdentifier.create(Neutron.class).child(Subnets.class).child(Subnet
 796                 .class, new SubnetKey(subnetId));
 797         Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
 798
 799         if (sn.isPresent()) {
 800             subnet = sn.get();
 801             addToSubnetCache(subnet);
 802         }
 803         return subnet;
 804     }
 805
 806     protected List<Subnetmap> getNeutronRouterSubnetMapList(Uuid routerId) {
 807         List<Subnetmap> subnetMapList = new ArrayList<>();
 808         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
 809                 InstanceIdentifier.builder(Subnetmaps.class).build());
 810         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
 811             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
 812                 if (routerId.equals(subnetmap.getRouterId())) {
 813                     subnetMapList.add(subnetmap);
 814                 }
 815             }
 816         }
 817         LOG.debug("getNeutronRouterSubnetMapList returns {}", subnetMapList);
 818         return subnetMapList;
 819     }
 820
 821     @Nonnull
 822     protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
 823         LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
 824         List<Uuid> subnetIdList = new ArrayList<>();
 825         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
 826             InstanceIdentifier.builder(Subnetmaps.class).build());
 827         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
 828             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
 829                 if (routerId.equals(subnetmap.getRouterId())) {
 830                     subnetIdList.add(subnetmap.getId());
 831                 }
 832             }
 833         }
 834         LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
 835         return subnetIdList;
 836     }
 837
 838     // TODO Clean up the exception handling and the console output
 839     @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
 840     @Nullable
 841     protected Short getIPPrefixFromPort(Port port) {
 842         try {
 843             Uuid subnetUUID = port.getFixedIps().get(0).getSubnetId();
 844             SubnetKey subnetkey = new SubnetKey(subnetUUID);
 845             InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class).child(Subnets
 846                     .class).child(Subnet.class, subnetkey);
 847             Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
 848             if (subnet.isPresent()) {
 849                 String cidr = subnet.get().getCidr().stringValue();
 850                 // Extract the prefix length from cidr
 851                 String[] parts = cidr.split("/");
 852                 if (parts.length == 2) {
 853                     return Short.valueOf(parts[1]);
 854                 } else {
 855                     LOG.trace("Could not retrieve prefix from subnet CIDR");
 856                 }
 857             } else {
 858                 LOG.trace("Unable to read on subnet datastore");
 859             }
 860         } catch (Exception e) {
 861             LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
 862         }
 863         LOG.error("Failed for port {}", port.getUuid().getValue());
 864         return null;
 865     }
 866
 867     // TODO Clean up the exception handling
 868     @SuppressWarnings("checkstyle:IllegalCatch")
 869     protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
 870             boolean isSubnetIp, TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
 871         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 872         VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
 873             .withKey(new VpnPortipToPortKey(fixedIp, vpnName))
 874             .setVpnName(vpnName).setPortFixedip(fixedIp)
 875             .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
 876         try {
 877             if (writeConfigTxn != null) {
 878                 writeConfigTxn.put(id, builder.build());
 879             } else {
 880                 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
 881             }
 882             LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
 883                 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
 884         } catch (Exception e) {
 885             LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 886                     e);
 887         }
 888     }
 889
 890     // TODO Clean up the exception handling
 891     @SuppressWarnings("checkstyle:IllegalCatch")
 892     protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp,
 893                                               TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
 894         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 895         try {
 896             if (writeConfigTxn != null) {
 897                 writeConfigTxn.delete(id);
 898             } else {
 899                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
 900             }
 901             LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
 902                     vpnName);
 903         } catch (Exception e) {
 904             LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 905                     e);
 906         }
 907     }
 908
 909     // TODO Clean up the exception handling
 910     @SuppressWarnings("checkstyle:IllegalCatch")
 911     protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
 912         InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
 913         try {
 914             synchronized ((vpnName + fixedIp).intern()) {
 915                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
 916             }
 917             LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
 918                     vpnName);
 919         } catch (Exception e) {
 920             LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
 921                 vpnName, fixedIp, e);
 922         }
 923     }
 924
 925     public void addToNetworkCache(Network network) {
 926         networkMap.put(network.getUuid(), network);
 927     }
 928
 929     public void removeFromNetworkCache(Network network) {
 930         networkMap.remove(network.getUuid());
 931     }
 932
 933     public void addToRouterCache(Router router) {
 934         routerMap.put(router.getUuid(), router);
 935     }
 936
 937     public void removeFromRouterCache(Router router) {
 938         routerMap.remove(router.getUuid());
 939     }
 940
 941     public Collection<Router> getAllRouters() {
 942         return routerMap.values();
 943     }
 944
 945     public void addToPortCache(Port port) {
 946         portMap.put(port.getUuid(), port);
 947     }
 948
 949     public void removeFromPortCache(Port port) {
 950         portMap.remove(port.getUuid());
 951     }
 952
 953     public void addToSubnetCache(Subnet subnet) {
 954         subnetMap.put(subnet.getUuid(), subnet);
 955         IpAddress gatewayIp = subnet.getGatewayIp();
 956         if (gatewayIp != null) {
 957             subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
 958         }
 959     }
 960
 961     public void removeFromSubnetCache(Subnet subnet) {
 962         subnetMap.remove(subnet.getUuid());
 963         IpAddress gatewayIp = subnet.getGatewayIp();
 964         if (gatewayIp != null) {
 965             Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
 966             if (gwIps != null) {
 967                 gwIps.remove(subnet.getUuid());
 968             }
 969         }
 970     }
 971
 972     public static String getSegmentationIdFromNeutronNetwork(Network network) {
 973         String segmentationId = null;
 974         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 975         if (providerExtension != null) {
 976             Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
 977             segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
 978         }
 979
 980         return segmentationId;
 981     }
 982
 983     public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
 984         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 985         return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
 986     }
 987
 988     public static String getPhysicalNetworkName(Network network) {
 989         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 990         return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
 991     }
 992
 993     public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
 994         return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
 995     }
 996
 997     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
 998         InstanceIdentifier<VpnPortipToPort> id =
 999             InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
1000                 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
1001         return id;
1002     }
1003
1004     static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
1005         InstanceIdentifier<LearntVpnVipToPort> id =
1006             InstanceIdentifier.builder(LearntVpnVipToPortData.class)
1007                 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1008         return id;
1009     }
1010
1011     static Boolean getIsExternal(Network network) {
1012         return network.augmentation(NetworkL3Extension.class) != null
1013                 && network.augmentation(NetworkL3Extension.class).isExternal();
1014     }
1015
1016     public void addToQosPolicyCache(QosPolicy qosPolicy) {
1017         qosPolicyMap.put(qosPolicy.getUuid(),qosPolicy);
1018     }
1019
1020     public void removeFromQosPolicyCache(QosPolicy qosPolicy) {
1021         qosPolicyMap.remove(qosPolicy.getUuid());
1022     }
1023
1024     public void addToQosPortsCache(Uuid qosUuid, Port port) {
1025         if (qosPortsMap.containsKey(qosUuid)) {
1026             if (!qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
1027                 qosPortsMap.get(qosUuid).put(port.getUuid(), port);
1028             }
1029         } else {
1030             HashMap<Uuid, Port> newPortMap = new HashMap<>();
1031             newPortMap.put(port.getUuid(), port);
1032             qosPortsMap.put(qosUuid, newPortMap);
1033         }
1034     }
1035
1036     public void removeFromQosPortsCache(Uuid qosUuid, Port port) {
1037         if (qosPortsMap.containsKey(qosUuid) && qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
1038             qosPortsMap.get(qosUuid).remove(port.getUuid(), port);
1039         }
1040     }
1041
1042     public void addToQosNetworksCache(Uuid qosUuid, Network network) {
1043         if (qosNetworksMap.containsKey(qosUuid)) {
1044             if (!qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
1045                 qosNetworksMap.get(qosUuid).put(network.getUuid(), network);
1046             }
1047         } else {
1048             HashMap<Uuid, Network> newNetworkMap = new HashMap<>();
1049             newNetworkMap.put(network.getUuid(), network);
1050             qosNetworksMap.put(qosUuid, newNetworkMap);
1051         }
1052     }
1053
1054     public void removeFromQosNetworksCache(Uuid qosUuid, Network network) {
1055         if (qosNetworksMap.containsKey(qosUuid) && qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
1056             qosNetworksMap.get(qosUuid).remove(network.getUuid(), network);
1057         }
1058     }
1059
1060     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1061         InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1062                 NetworkMapKey(networkId)).build();
1063         return id;
1064     }
1065
1066     static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
1067         InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
1068                 .class, new VpnInterfaceKey(ifName)).build();
1069         return id;
1070     }
1071
1072     static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
1073         InstanceIdentifier<Subnetmap> id = InstanceIdentifier.builder(Subnetmaps.class).child(Subnetmap.class, new
1074                 SubnetmapKey(subnetId)).build();
1075         return id;
1076     }
1077
1078     static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
1079         InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
1080                 InterfaceKey(interfaceName)).build();
1081         return id;
1082     }
1083
1084     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1085             .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1086         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1087                 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1088                 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1089                 .getValue())).build();
1090         return id;
1091     }
1092
1093     static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1094         return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1095                 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1096     }
1097
1098     static InstanceIdentifier<PortSubnet> buildPortSubnetIdentifier(String portId) {
1099         InstanceIdentifier<PortSubnet> id = InstanceIdentifier.builder(PortSubnets.class)
1100                 .child(PortSubnet.class, new PortSubnetKey(portId)).build();
1101         return id;
1102     }
1103
1104     // TODO Remove this method entirely
1105     @SuppressWarnings("checkstyle:IllegalCatch")
1106     private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1107         try {
1108             return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1109         } catch (ReadFailedException e) {
1110             throw new RuntimeException(e);
1111         }
1112     }
1113
1114     public static Class<? extends NetworkTypeBase> getNetworkType(Network network) {
1115         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
1116         return providerExtension != null ? providerExtension.getNetworkType() : null;
1117     }
1118
1119     @Nullable
1120     static ProviderTypes getProviderNetworkType(Network network) {
1121         if (network == null) {
1122             LOG.error("Error in getting provider network type since network is null");
1123             return null;
1124         }
1125         NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1126         if (npe != null) {
1127             Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1128             if (networkTypeBase != null) {
1129                 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1130                     return ProviderTypes.FLAT;
1131                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1132                     return ProviderTypes.VLAN;
1133                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1134                     return ProviderTypes.VXLAN;
1135                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1136                     return ProviderTypes.GRE;
1137                 }
1138             }
1139         }
1140         LOG.error("Error in getting provider network type since network provider extension is null for network "
1141                 + "{}", network.getUuid().getValue());
1142         return null;
1143     }
1144
1145     static boolean isNetworkTypeSupported(Network network) {
1146         NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1147         return npe != null && npe.getNetworkType() != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1148     }
1149
1150     static boolean isNetworkOfType(Network network, Class<? extends NetworkTypeBase> type) {
1151         NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1152         if (npe != null && npe.getNetworkType() != null) {
1153             return type.isAssignableFrom(npe.getNetworkType());
1154         }
1155         return false;
1156     }
1157
1158     static boolean isFlatOrVlanNetwork(Network network) {
1159         return network != null
1160                 && (isNetworkOfType(network, NetworkTypeVlan.class) || isNetworkOfType(network, NetworkTypeFlat.class));
1161     }
1162
1163     static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1164         return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1165     }
1166
1167     /**
1168      * Get inter-VPN link state.
1169      *
1170      * @param vpnLinkName VPN link name
1171      * @return Optional of InterVpnLinkState
1172      */
1173     public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1174         InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1175                 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1176         return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1177     }
1178
1179     /**
1180      * Returns an InterVpnLink by searching by one of its endpoint's IP.
1181      *
1182      * @param endpointIp IP to search for
1183      * @return a InterVpnLink
1184      */
1185     public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1186         InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1187         Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1188                 interVpnLinksIid);
1189         if (interVpnLinksOpData.isPresent()) {
1190             for (InterVpnLink interVpnLink : requireNonNullElse(interVpnLinksOpData.get().getInterVpnLink(),
1191                     Collections.<InterVpnLink>emptyList())) {
1192                 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1193                         || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1194                     return Optional.of(interVpnLink);
1195                 }
1196             }
1197         }
1198         return Optional.absent();
1199     }
1200
1201     public Set<RouterDpnList> getAllRouterDpnList(BigInteger dpid) {
1202         Set<RouterDpnList> ret = new HashSet<>();
1203         InstanceIdentifier<NeutronRouterDpns> routerDpnId =
1204                 InstanceIdentifier.create(NeutronRouterDpns.class);
1205         Optional<NeutronRouterDpns> neutronRouterDpnsOpt =
1206             MDSALUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, routerDpnId);
1207         if (neutronRouterDpnsOpt.isPresent()) {
1208             NeutronRouterDpns neutronRouterDpns = neutronRouterDpnsOpt.get();
1209             for (RouterDpnList routerDpnList : requireNonNullElse(neutronRouterDpns.getRouterDpnList(),
1210                     Collections.<RouterDpnList>emptyList())) {
1211                 if (routerDpnList.getDpnVpninterfacesList() != null) {
1212                     for (DpnVpninterfacesList dpnInterfaceList : routerDpnList.getDpnVpninterfacesList()) {
1213                         if (dpnInterfaceList.getDpnId().equals(dpid)) {
1214                             ret.add(routerDpnList);
1215                         }
1216                     }
1217                 }
1218             }
1219         }
1220         return ret;
1221     }
1222
1223     @Nullable
1224     protected Integer getUniqueRDId(String poolName, String idKey) {
1225         AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1226         try {
1227             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
1228             RpcResult<AllocateIdOutput> rpcResult = result.get();
1229             if (rpcResult.isSuccessful()) {
1230                 return rpcResult.getResult().getIdValue().intValue();
1231             } else {
1232                 LOG.error("RPC call to get unique ID for pool name {} with ID key {} returned with errors {}",
1233                         poolName, idKey, rpcResult.getErrors());
1234             }
1235         } catch (InterruptedException | ExecutionException e) {
1236             LOG.error("Exception when getting Unique Id for poolname {} and ID Key {}", poolName, idKey, e);
1237         }
1238         LOG.error("getUniqueRdId: Failed to return ID for poolname {} and ID Key {}", poolName, idKey);
1239         return null;
1240     }
1241
1242     protected void releaseRDId(String poolName, String idKey) {
1243         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1244         try {
1245             RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).get();
1246             if (!rpcResult.isSuccessful()) {
1247                 LOG.error("RPC Call to Get Unique Id returned with errors for poolname {} and ID Key {}: {}",
1248                         poolName, idKey, rpcResult.getErrors());
1249             } else {
1250                 LOG.info("ID {} for RD released successfully", idKey);
1251             }
1252         } catch (InterruptedException | ExecutionException e) {
1253             LOG.error("Exception when trying to release ID for poolname {} and ID Key {}", poolName, idKey, e);
1254         }
1255     }
1256
1257     protected static IpAddress getIpv6LinkLocalAddressFromMac(MacAddress mac) {
1258         byte[] octets = bytesFromHexString(mac.getValue());
1259
1260         /* As per the RFC2373, steps involved to generate a LLA include
1261            1. Convert the 48 bit MAC address to 64 bit value by inserting 0xFFFE
1262               between OUI and NIC Specific part.
1263            2. Invert the Universal/Local flag in the OUI portion of the address.
1264            3. Use the prefix "FE80::/10" along with the above 64 bit Interface
1265               identifier to generate the IPv6 LLA. */
1266
1267         StringBuilder interfaceID = new StringBuilder();
1268         short u8byte = (short) (octets[0] & 0xff);
1269         u8byte ^= 1 << 1;
1270         interfaceID.append(Integer.toHexString(0xFF & u8byte));
1271         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[1]), 2, "0"));
1272         interfaceID.append(":");
1273         interfaceID.append(Integer.toHexString(0xFF & octets[2]));
1274         interfaceID.append("ff:fe");
1275         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[3]), 2, "0"));
1276         interfaceID.append(":");
1277         interfaceID.append(Integer.toHexString(0xFF & octets[4]));
1278         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[5]), 2, "0"));
1279
1280         Ipv6Address ipv6LLA = new Ipv6Address("fe80:0:0:0:" + interfaceID.toString());
1281         IpAddress ipAddress = new IpAddress(ipv6LLA);
1282         return ipAddress;
1283     }
1284
1285     protected static byte[] bytesFromHexString(String values) {
1286         String target = "";
1287         if (values != null) {
1288             target = values;
1289         }
1290         String[] octets = target.split(":");
1291
1292         byte[] ret = new byte[octets.length];
1293         for (int i = 0; i < octets.length; i++) {
1294             ret[i] = Integer.valueOf(octets[i], 16).byteValue();
1295         }
1296         return ret;
1297     }
1298
1299     public List<String> getExistingRDs() {
1300         List<String> existingRDs = new ArrayList<>();
1301         InstanceIdentifier<VpnInstances> path = InstanceIdentifier.builder(VpnInstances.class).build();
1302         Optional<VpnInstances> vpnInstancesOptional = read(LogicalDatastoreType.CONFIGURATION, path);
1303         if (vpnInstancesOptional.isPresent() && vpnInstancesOptional.get().getVpnInstance() != null) {
1304             for (VpnInstance vpnInstance : vpnInstancesOptional.get().getVpnInstance()) {
1305                 if (vpnInstance.getIpv4Family() == null) {
1306                     continue;
1307                 }
1308                 List<String> rds = vpnInstance.getIpv4Family().getRouteDistinguisher();
1309                 if (rds != null) {
1310                     existingRDs.addAll(rds);
1311                 }
1312             }
1313         }
1314         return existingRDs;
1315     }
1316
1317     protected boolean doesVpnExist(Uuid vpnId) {
1318         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
1319                 new VpnMapKey(vpnId)).build();
1320         return read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier).isPresent();
1321     }
1322
1323     protected Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external
1324         .subnets.Subnets> getOptionalExternalSubnets(Uuid subnetId) {
1325         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1326             .rev160111.external.subnets.Subnets> subnetsIdentifier =
1327                 InstanceIdentifier.builder(ExternalSubnets.class)
1328                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1329                         .rev160111.external.subnets.Subnets.class, new SubnetsKey(subnetId)).build();
1330         return read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1331     }
1332
1333     public static List<StaticMacEntries> buildStaticMacEntry(Port port) {
1334         PhysAddress physAddress = new PhysAddress(port.getMacAddress().getValue());
1335         List<FixedIps> fixedIps = port.getFixedIps();
1336         IpAddress ipAddress = null;
1337         if (isNotEmpty(fixedIps)) {
1338             ipAddress = port.getFixedIps().get(0).getIpAddress();
1339         }
1340         StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
1341         List<StaticMacEntries> staticMacEntries = new ArrayList<>();
1342         if (ipAddress != null) {
1343             staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).setIpPrefix(ipAddress).build());
1344         } else {
1345             staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).build());
1346         }
1347         return staticMacEntries;
1348     }
1349
1350     public static boolean isEmpty(Collection<?> collection) {
1351         return collection == null || collection.isEmpty();
1352     }
1353
1354     public static boolean isNotEmpty(Collection<?> collection) {
1355         return !isEmpty(collection);
1356     }
1357
1358     /**
1359      * Method to get an ipVersionChosen as IPV4 and/or IPV6 or undefined from the subnetmaps of the router.
1360      * @param routerUuid the Uuid for which find out the IP version associated
1361      * @return an IpVersionChoice used by the router from its attached subnetmaps. IpVersionChoice.UNDEFINED if any
1362      */
1363     public IpVersionChoice getIpVersionChoicesFromRouterUuid(Uuid routerUuid) {
1364         IpVersionChoice rep = IpVersionChoice.UNDEFINED;
1365         if (routerUuid == null) {
1366             return rep;
1367         }
1368         List<Subnetmap> subnetmapList = getNeutronRouterSubnetMaps(routerUuid);
1369         if (subnetmapList.isEmpty()) {
1370             return rep;
1371         }
1372         for (Subnetmap sn : subnetmapList) {
1373             if (sn.getSubnetIp() != null) {
1374                 IpVersionChoice ipVers = getIpVersionFromString(sn.getSubnetIp());
1375                 if (rep.choice != ipVers.choice) {
1376                     rep = rep.addVersion(ipVers);
1377                 }
1378                 if (rep.choice == IpVersionChoice.IPV4AND6.choice) {
1379                     return rep;
1380                 }
1381             }
1382         }
1383         return rep;
1384     }
1385
1386     /**This method return the list of Subnetmap associated to the router or a empty list if any.
1387      * @param routerId the Uuid of router for which subnetmap is find out
1388      * @return a list of Subnetmap associated to the router. it could be empty if any
1389      */
1390     protected List<Subnetmap> getNeutronRouterSubnetMaps(Uuid routerId) {
1391         List<Subnetmap> subnetIdList = new ArrayList<>();
1392         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
1393             InstanceIdentifier.builder(Subnetmaps.class).build());
1394         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
1395             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
1396                 if (routerId.equals(subnetmap.getRouterId())) {
1397                     subnetIdList.add(subnetmap);
1398                 }
1399             }
1400         }
1401         return subnetIdList;
1402     }
1403
1404     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1405         .instance.to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
1406         return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
1407             .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1408                     .instance.to.vpn.id.VpnInstance.class,
1409                 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1410                     .instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
1411     }
1412
1413     /**
1414      * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
1415      * @param vpnName Name of the VPN
1416      *
1417      * @return the route-distinguisher of the VPN
1418      */
1419     @Nullable
1420     public String getVpnRd(String vpnName) {
1421         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1422             .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1423         return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1424                 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1425                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1426                         .VpnInstance::getVrfId).orElse(null);
1427     }
1428
1429     /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1430      * @param ipAddress String of an representation IP address V4 or V6
1431      * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1432      */
1433     public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1434         IpVersionChoice ipchoice = IpVersionChoice.UNDEFINED;
1435         if (ipAddress.contains("/")) {
1436             ipAddress = ipAddress.substring(0, ipAddress.indexOf("/"));
1437         }
1438         try {
1439             InetAddress address = InetAddress.getByName(ipAddress);
1440             if (address instanceof Inet4Address) {
1441                 return IpVersionChoice.IPV4;
1442             } else if (address instanceof Inet6Address) {
1443                 return IpVersionChoice.IPV6;
1444             }
1445         } catch (UnknownHostException | SecurityException e) {
1446             LOG.error("getIpVersionFromString: could not  find version for {}", ipAddress);
1447         }
1448         return ipchoice;
1449     }
1450
1451     /**Get IpVersionChoice from Uuid Subnet.
1452      * @param sm Subnetmap structure
1453      * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1454      */
1455     public static IpVersionChoice getIpVersionFromSubnet(Subnetmap sm) {
1456         if (sm != null && sm.getSubnetIp() != null) {
1457             return getIpVersionFromString(sm.getSubnetIp());
1458         }
1459         return IpVersionChoice.UNDEFINED;
1460     }
1461
1462     @Nullable
1463     public VpnInstanceOpDataEntry getVpnInstanceOpDataEntryFromVpnId(String vpnName) {
1464         String primaryRd = getVpnRd(vpnName);
1465         if (primaryRd == null) {
1466             LOG.error("getVpnInstanceOpDataEntryFromVpnId: Vpn Instance {} "
1467                      + "Primary RD not found", vpnName);
1468             return null;
1469         }
1470         InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1471         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1472         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1473             LOG.error("getVpnInstanceOpDataEntryFromVpnId: VpnInstance {} not found", primaryRd);
1474             return null;
1475         }
1476         return vpnInstanceOpDataEntryOptional.get();
1477     }
1478
1479     protected InstanceIdentifier<VpnInstanceOpDataEntry> getVpnOpDataIdentifier(String primaryRd) {
1480         return InstanceIdentifier.builder(VpnInstanceOpData.class)
1481                 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1482     }
1483
1484     public boolean shouldVpnHandleIpVersionChoiceChange(IpVersionChoice ipVersion, Uuid routerId, boolean add) {
1485         int subnetCount = -1;
1486         if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1487             subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1488         } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1489             subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1490         } else {
1491             //Possible value of ipversion choice is either V4 or V6 only. Not accepted V4andV6 and Undefined
1492             return false;
1493         }
1494         /* ADD: Update vpnInstanceOpDataEntry with address family only on first IPv4/IPv6 subnet
1495          * for the VPN Instance.
1496          *
1497          * REMOVE: Update vpnInstanceOpDataEntry with address family only on last IPv4/IPv6 subnet
1498          * for the VPN Instance.
1499          */
1500         if (add && subnetCount == 1) {
1501             return true;
1502         } else if (!add && subnetCount == 0) {
1503             return true;
1504         } else {
1505             return false;
1506         }
1507     }
1508
1509     public boolean shouldVpnHandleIpVersionChangeToRemove(Subnetmap sm, Uuid vpnId) {
1510         if (sm == null) {
1511             return false;
1512         }
1513         InstanceIdentifier<Subnetmaps> subnetMapsId = InstanceIdentifier.builder(Subnetmaps.class).build();
1514         Optional<Subnetmaps> allSubnetMaps = read(LogicalDatastoreType.CONFIGURATION, subnetMapsId);
1515         // calculate and store in list IpVersion for each subnetMap, belonging to current VpnInstance
1516         List<IpVersionChoice> snIpVersions = new ArrayList<>();
1517         for (Subnetmap snMap : requireNonNullElse(allSubnetMaps.get().getSubnetmap(),
1518                 Collections.<Subnetmap>emptyList())) {
1519             if (snMap.getId().equals(sm.getId())) {
1520                 continue;
1521             }
1522             if (snMap.getVpnId() != null && snMap.getVpnId().equals(vpnId)) {
1523                 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1524             }
1525             if (snMap.getInternetVpnId() != null && snMap.getInternetVpnId().equals(vpnId)) {
1526                 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1527             }
1528         }
1529         IpVersionChoice ipVersion = getIpVersionFromString(sm.getSubnetIp());
1530         if (!snIpVersions.contains(ipVersion)) {
1531             return true;
1532         }
1533         return false;
1534     }
1535
1536     public int getSubnetCountFromRouter(Uuid routerId, IpVersionChoice ipVer) {
1537         List<Subnetmap> subnetMapList = getNeutronRouterSubnetMapList(routerId);
1538         int subnetCount = 0;
1539         for (Subnetmap subMap : subnetMapList) {
1540             IpVersionChoice ipVersion = getIpVersionFromString(subMap.getSubnetIp());
1541             if (ipVersion.isIpVersionChosen(ipVer)) {
1542                 subnetCount++;
1543             }
1544             if (subnetCount > 1) {
1545                 break;
1546             }
1547         }
1548         return subnetCount;
1549     }
1550
1551     public void updateVpnInstanceWithIpFamily(String vpnName, IpVersionChoice ipVersion, boolean add) {
1552         jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
1553             VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName);
1554             if (vpnInstanceOpDataEntry == null) {
1555                 return Collections.emptyList();
1556             }
1557             if (vpnInstanceOpDataEntry.getType() == VpnInstanceOpDataEntry.Type.L2) {
1558                 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with ipFamily {}."
1559                         + "VpnInstanceOpDataEntry is L2 instance. Do nothing.", vpnName, ipVersion);
1560                 return Collections.emptyList();
1561             }
1562             if (ipVersion == IpVersionChoice.UNDEFINED) {
1563                 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with Undefined address family"
1564                         + "is not allowed. Do nothing", vpnName);
1565                 return Collections.emptyList();
1566             }
1567             VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1568             boolean ipConfigured = add;
1569             if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4AND6)) {
1570                 builder.setIpv4Configured(ipConfigured);
1571                 builder.setIpv6Configured(ipConfigured);
1572             } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1573                 builder.setIpv4Configured(ipConfigured);
1574             } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1575                 builder.setIpv6Configured(ipConfigured);
1576             }
1577             return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1578                     OPERATIONAL, tx -> {
1579                     InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier
1580                             .builder(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class,
1581                                         new VpnInstanceOpDataEntryKey(vpnInstanceOpDataEntry.getVrfId())).build();
1582                     tx.merge(id, builder.build(), false);
1583                     LOG.info("updateVpnInstanceWithIpFamily: Successfully {} {} to Vpn {}",
1584                             add == true ? "added" : "removed", ipVersion, vpnName);
1585                 }));
1586         });
1587     }
1588
1589     /**
1590      * Get the vpnInstance from its Uuid.
1591      *
1592      * @param broker to get informations from ds
1593      * @param vpnId the Uuid of the VPN
1594      * @return the VpnInstance or null if unfindable
1595      */
1596     @Nullable
1597     public VpnInstance getVpnInstance(DataBroker broker, Uuid vpnId) {
1598         if (broker == null || vpnId == null) {
1599             return null;
1600         }
1601         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
1602                 new VpnInstanceKey(vpnId.getValue())).build();
1603         Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1604         return vpnInstance.isPresent() ? vpnInstance.get() : null;
1605     }
1606
1607     /**
1608      *Get the Uuid of external network of the router (remember you that one router have only one external network).
1609      * @param routerId the Uuid of the router which you try to reach the external network
1610      * @return Uuid of externalNetwork or null if is not exist
1611      */
1612     protected Uuid getExternalNetworkUuidAttachedFromRouterUuid(@Nonnull Uuid routerId) {
1613         LOG.debug("getExternalNetworkUuidAttachedFromRouterUuid for {}", routerId.getValue());
1614         Uuid externalNetworkUuid = null;
1615         Router router = getNeutronRouter(routerId);
1616         if (router != null && router.getExternalGatewayInfo() != null) {
1617             externalNetworkUuid = router.getExternalGatewayInfo().getExternalNetworkId();
1618         }
1619         return externalNetworkUuid;
1620     }
1621
1622     public Uuid getInternetvpnUuidBoundToRouterId(@Nonnull Uuid routerId) {
1623         Uuid netId = getExternalNetworkUuidAttachedFromRouterUuid(routerId);
1624         if (netId == null) {
1625             return netId;
1626         }
1627         return getVpnForNetwork(netId);
1628     }
1629
1630     /**
1631      * This method get Uuid of internet vpn if existing one bound to the same router of the subnetUuid arg.
1632      * Explanation: If the subnet (of arg subnetUuid) have a router bound and this router have an
1633      * externalVpn (vpn on externalProvider network) then <b>its Uuid</b> will be returned.
1634      * @param subnetUuid Uuid of subnet where you are finding a link to an external network
1635      * @return Uuid of externalVpn or null if it is not found
1636      */
1637     @Nullable
1638     public Uuid getInternetvpnUuidBoundToSubnetRouter(@Nonnull Uuid subnetUuid) {
1639         Subnetmap subnetmap = getSubnetmap(subnetUuid);
1640         Uuid routerUuid = subnetmap.getRouterId();
1641         LOG.debug("getInternetvpnUuidBoundToSubnetRouter for subnetUuid {}", subnetUuid.getValue());
1642         if (routerUuid == null) {
1643             return null;
1644         }
1645         Uuid externalNetworkUuid = getExternalNetworkUuidAttachedFromRouterUuid(routerUuid);
1646         return externalNetworkUuid != null ? getVpnForNetwork(externalNetworkUuid) : null;
1647     }
1648
1649     /**
1650      * Get a list of Private Subnetmap Ids from router to export then its prefixes in Internet VPN.
1651      * @param extNet Provider Network, which has a port attached as external network gateway to router
1652      * @return a list of Private Subnetmap Ids of the router with external network gateway
1653      */
1654     public @Nonnull List<Uuid> getPrivateSubnetsToExport(@Nonnull Network extNet, Uuid internetVpnId) {
1655         List<Uuid> subList = new ArrayList<>();
1656         List<Uuid> rtrList = new ArrayList<>();
1657         if (internetVpnId != null) {
1658             rtrList.addAll(getRouterIdListforVpn(internetVpnId));
1659         } else {
1660             Uuid extNwVpnId = getVpnForNetwork(extNet.getUuid());
1661             rtrList.addAll(getRouterIdListforVpn(extNwVpnId));
1662         }
1663         if (rtrList.isEmpty()) {
1664             return subList;
1665         }
1666         for (Uuid rtrId: rtrList) {
1667             Router router = getNeutronRouter(rtrId);
1668             ExternalGatewayInfo info = router.getExternalGatewayInfo();
1669             if (info == null) {
1670                 LOG.error("getPrivateSubnetsToExport: can not get info about external gateway for router {}",
1671                           router.getUuid().getValue());
1672                 continue;
1673             }
1674             // check that router really has given provider network as its external gateway port
1675             if (!extNet.getUuid().equals(info.getExternalNetworkId())) {
1676                 LOG.error("getPrivateSubnetsToExport: router {} is not attached to given provider network {}",
1677                           router.getUuid().getValue(), extNet.getUuid().getValue());
1678                 continue;
1679             }
1680             subList.addAll(getNeutronRouterSubnetIds(rtrId));
1681         }
1682         return subList;
1683     }
1684
1685     public void updateVpnInstanceWithFallback(Uuid routerId, Uuid vpnName, boolean add) {
1686         VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName.getValue());
1687         if (vpnInstanceOpDataEntry == null) {
1688             LOG.error("updateVpnInstanceWithFallback: vpnInstanceOpDataEntry not found for vpn {}", vpnName);
1689             return;
1690         }
1691         Long internetBgpVpnId = vpnInstanceOpDataEntry.getVpnId();
1692         List<Uuid> routerIds = new ArrayList<>();
1693         //Handle router specific V6 internet fallback flow else handle all V6 external routers
1694         if (routerId != null) {
1695             routerIds.add(routerId);
1696         } else {
1697             //This block will execute for ext-nw to Internet VPN association/disassociation event.
1698             routerIds = getRouterIdListforVpn(vpnName);
1699         }
1700         if (routerIds == null || routerIds.isEmpty()) {
1701             LOG.error("updateVpnInstanceWithFallback: router not found for vpn {}", vpnName);
1702             return;
1703         }
1704         for (Uuid rtrId: routerIds) {
1705             if (rtrId == null) {
1706                 continue;
1707             }
1708             List<BigInteger> dpnIds = getDpnsForRouter(rtrId.getValue());
1709             if (dpnIds.isEmpty()) {
1710                 continue;
1711             }
1712             VpnInstanceOpDataEntry vpnOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(rtrId.getValue());
1713             Long routerIdAsLong = vpnOpDataEntry.getVpnId();
1714             long vpnId;
1715             Uuid rtrVpnId = getVpnForRouter(rtrId, true);
1716             if (rtrVpnId == null) {
1717                 //If external BGP-VPN is not associated with router then routerId is same as routerVpnId
1718                 vpnId = routerIdAsLong;
1719             } else {
1720                 vpnId = getVpnId(rtrVpnId.getValue());
1721             }
1722             for (BigInteger dpnId : dpnIds) {
1723                 if (add) {
1724                     ipV6InternetDefRt.installDefaultRoute(dpnId, rtrId.getValue(), internetBgpVpnId, vpnId);
1725                 } else {
1726                     ipV6InternetDefRt.removeDefaultRoute(dpnId, rtrId.getValue(), internetBgpVpnId, vpnId);
1727                 }
1728             }
1729         }
1730     }
1731
1732     public void updateVpnInstanceOpWithType(VpnInstanceOpDataEntry.BgpvpnType choice, @Nonnull Uuid vpn) {
1733         String primaryRd = getVpnRd(vpn.getValue());
1734         if (primaryRd == null) {
1735             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1736                     + "Primary RD not found", choice, vpn.getValue());
1737             return;
1738         }
1739         InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1740               .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1741
1742         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1743             read(LogicalDatastoreType.OPERATIONAL, id);
1744         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1745             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1746                     + "VpnInstanceOpDataEntry not found", choice, vpn.getValue());
1747             return;
1748         }
1749         VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnInstanceOpDataEntryOptional.get();
1750         if (vpnInstanceOpDataEntry.getBgpvpnType().equals(choice)) {
1751             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1752                     + "VpnInstanceOpDataEntry already set", choice, vpn.getValue());
1753             return;
1754         }
1755         VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1756         builder.setBgpvpnType(choice);
1757         ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
1758             tx.merge(id, builder.build(), false);
1759             LOG.debug("updateVpnInstanceOpWithType: sent merge to operDS BgpvpnType {} for {}", choice, vpn.getValue());
1760         }), LOG, "Error updating VPN instance op {} with type {}", vpn, choice);
1761     }
1762
1763     public List<Uuid> getAssociateRouterInputRouterIdsListUuid(List<RouterIds> routerIds) {
1764         if (routerIds == null) {
1765             return Collections.emptyList();
1766         }
1767         return routerIds.stream().map(
1768             routerId -> routerId.getRouterId()).collect(Collectors.toList());
1769     }
1770
1771     public List<Uuid> getDisassociateRouterInputRouterIdsListUuid(List<RouterIds> routerIds) {
1772         if (routerIds == null) {
1773             return Collections.emptyList();
1774         }
1775         return routerIds.stream().map(
1776             routerId -> routerId.getRouterId()).collect(Collectors.toList());
1777     }
1778
1779     public RouterIds getvpnMapRouterIds(Uuid routerId) {
1780         return new RouterIdsBuilder().setRouterId(routerId).build();
1781     }
1782
1783     public void removeVpnMapRouterIdsFromList(Uuid routerId, List<RouterIds> vpnRouterIds) {
1784         Iterator<RouterIds> vpnRouterIdIter = vpnRouterIds.iterator();
1785         while (vpnRouterIdIter.hasNext()) {
1786             RouterIds vpnRouterId = vpnRouterIdIter.next();
1787             if (vpnRouterId.getRouterId().getValue().equals(routerId.getValue())) {
1788                 vpnRouterIdIter.remove();
1789                 return;
1790             }
1791         }
1792         return;
1793     }
1794
1795     public boolean vpnMapRouterIdsContainsRouterId(Uuid routerId, List<RouterIds> vpnRouterIds) {
1796         if (routerId == null) {
1797             return false;
1798         }
1799         return vpnRouterIds.stream().anyMatch(vpnRouterId ->
1800               vpnRouterId.getRouterId().getValue().equals(routerId.getValue()));
1801     }
1802
1803     public List<Uuid> getVpnInstanceRouterIdsListUuid(List<RouterIds> routerIds) {
1804         if (routerIds == null) {
1805             return Collections.emptyList();
1806         }
1807         return routerIds.stream().map(
1808             routerId -> routerId.getRouterId()).collect(Collectors.toList());
1809     }
1810
1811     public static RouterIds getvpnInstanceRouterIds(Uuid routerId) {
1812         return new RouterIdsBuilder().setRouterId(routerId).build();
1813     }
1814
1815     public static List<RouterIds> getVpnInstanceRouterIdsList(List<Uuid> routerIds) {
1816         List<RouterIds> listRouterIds = new ArrayList<>();
1817         for (Uuid routerId : routerIds) {
1818             final RouterIds routerIdInstance = getvpnInstanceRouterIds(routerId);
1819             listRouterIds.add(routerIdInstance);
1820         }
1821         return listRouterIds;
1822     }
1823
1824     @Nonnull
1825     public List<BigInteger> getDpnsForRouter(String routerUuid) {
1826         InstanceIdentifier id = InstanceIdentifier.builder(NeutronRouterDpns.class)
1827             .child(RouterDpnList.class, new RouterDpnListKey(routerUuid)).build();
1828         Optional<RouterDpnList> routerDpnListData =
1829                 SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1830                         LogicalDatastoreType.OPERATIONAL, id);
1831         List<BigInteger> dpns = new ArrayList<>();
1832         if (routerDpnListData.isPresent()) {
1833             for (DpnVpninterfacesList dpnVpnInterface : requireNonNullElse(
1834                     routerDpnListData.get().getDpnVpninterfacesList(), Collections.<DpnVpninterfacesList>emptyList())) {
1835                 dpns.add(dpnVpnInterface.getDpnId());
1836             }
1837         }
1838         return dpns;
1839     }
1840
1841     @Nullable
1842     public List<Uuid> getRouterIdsfromVpnInstance(String vpnName) {
1843         // returns only router, attached to IPv4 networks
1844         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class)
1845             .child(VpnMap.class, new VpnMapKey(new Uuid(vpnName))).build();
1846         Optional<VpnMap> optionalVpnMap = SingleTransactionDataBroker
1847                 .syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1848                         LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
1849         if (!optionalVpnMap.isPresent()) {
1850             LOG.error("getRouterIdsfromVpnInstance : Router not found for vpn : {}", vpnName);
1851             return null;
1852         }
1853         List<Uuid> rtrIds = optionalVpnMap.get().getRouterIds().stream().map(routerIds -> routerIds.getRouterId())
1854                 .collect(Collectors.toList());
1855         return rtrIds;
1856
1857     }
1858
1859     public InstanceIdentifier<Router> buildNeutronRouterIdentifier(Uuid routerUuid) {
1860         InstanceIdentifier<Router> routerInstanceIdentifier = InstanceIdentifier.create(Neutron.class)
1861              .child(Routers.class).child(Router.class, new RouterKey(routerUuid));
1862         return routerInstanceIdentifier;
1863     }
1864
1865     @Nullable
1866     List<Subnetmap> getSubnetmapListFromNetworkId(Uuid networkId) {
1867         List<Uuid> subnetIdList = getSubnetIdsFromNetworkId(networkId);
1868         if (subnetIdList != null) {
1869             List<Subnetmap> subnetmapList = new ArrayList<>();
1870             for (Uuid subnetId : subnetIdList) {
1871                 Subnetmap subnetmap = getSubnetmap(subnetId);
1872                 if (subnetmap != null) {
1873                     subnetmapList.add(subnetmap);
1874                 } else {
1875                     LOG.error("getSubnetmapListFromNetworkId: subnetmap is null for subnet {} belonging to network {}",
1876                             subnetId.getValue(), networkId.getValue());
1877                 }
1878             }
1879             return subnetmapList;
1880         }
1881         LOG.error("getSubnetmapListFromNetworkId: Failed as subnetIdList is null for network {}",
1882                 networkId.getValue());
1883         return null;
1884     }
1885
1886     @Nullable
1887     public long getVpnId(String vpnName) {
1888         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1889                 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1890         return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1891                 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1892                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1893                         .VpnInstance::getVpnId).orElse(null);
1894     }
1895
1896     protected boolean isV6SubnetPartOfRouter(Uuid routerId) {
1897         List<Subnetmap> subnetList = getNeutronRouterSubnetMapList(routerId);
1898         for (Subnetmap sm: subnetList) {
1899             if (sm == null) {
1900                 continue;
1901             }
1902             IpVersionChoice ipVers = getIpVersionFromString(sm.getSubnetIp());
1903             //skip further subnet processing once found first V6 subnet for the router
1904             if (ipVers.isIpVersionChosen(IpVersionChoice.IPV6)) {
1905                 return true;
1906             }
1907         }
1908         return false;
1909     }
1910 }