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

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