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