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.l3.rev150712.routers.attributes.routers.router.ExternalGatewayInfo;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.portsecurity.rev150712.PortSecurityExtension;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.QosPolicy;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
 137 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinkStates;
 138 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinks;
 139 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
 140 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateKey;
 141 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
 142 import org.opendaylight.yangtools.yang.binding.DataObject;
 143 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 144 import org.opendaylight.yangtools.yang.common.RpcResult;
 145 import org.slf4j.Logger;
 146 import org.slf4j.LoggerFactory;
 147
 148 @Singleton
 149 public class NeutronvpnUtils {
 150
 151     private static final Logger LOG = LoggerFactory.getLogger(NeutronvpnUtils.class);
 152     private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>
 153         NETWORK_MAP =
 154         new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
 155             .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
 156             .put(NetworkTypeGre.class, SegmentTypeGre.class)
 157             .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
 158             .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
 159             .build();
 160
 161     private static final Set<Class<? extends NetworkTypeBase>> SUPPORTED_NETWORK_TYPES = new HashSet<>();
 162
 163     static {
 164         SUPPORTED_NETWORK_TYPES.add(NetworkTypeFlat.class);
 165         SUPPORTED_NETWORK_TYPES.add(NetworkTypeVlan.class);
 166         SUPPORTED_NETWORK_TYPES.add(NetworkTypeVxlan.class);
 167         SUPPORTED_NETWORK_TYPES.add(NetworkTypeGre.class);
 168     }
 169
 170     private final ConcurrentMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
 171     private final ConcurrentMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
 172     private final ConcurrentMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
 173     private final ConcurrentMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
 174     private final Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
 175     private final ConcurrentMap<Uuid, QosPolicy> qosPolicyMap = new ConcurrentHashMap<>();
 176     private final ConcurrentMap<Uuid, HashMap<Uuid, Port>> qosPortsMap = new ConcurrentHashMap<>();
 177     private final ConcurrentMap<Uuid, HashMap<Uuid, Network>> qosNetworksMap = new ConcurrentHashMap<>();
 178
 179     private final DataBroker dataBroker;
 180     private final IdManagerService idManager;
 181     private final JobCoordinator jobCoordinator;
 182     private IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt;
 183
 184     @Inject
 185     public NeutronvpnUtils(final DataBroker dataBroker, final IdManagerService idManager,
 186             final JobCoordinator jobCoordinator, final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt) {
 187         this.dataBroker = dataBroker;
 188         this.idManager = idManager;
 189         this.jobCoordinator = jobCoordinator;
 190         this.ipV6InternetDefRt = ipV6InternetDefRt;
 191     }
 192
 193     protected Subnetmap getSubnetmap(Uuid subnetId) {
 194         InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
 195         Optional<Subnetmap> sn = read(LogicalDatastoreType.CONFIGURATION, id);
 196
 197         if (sn.isPresent()) {
 198             return sn.get();
 199         }
 200         LOG.error("getSubnetmap failed, subnet {} is not present", subnetId.getValue());
 201         return null;
 202     }
 203
 204     public VpnMap getVpnMap(Uuid id) {
 205         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 206                 new VpnMapKey(id)).build();
 207         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 208         if (optionalVpnMap.isPresent()) {
 209             return optionalVpnMap.get();
 210         }
 211         LOG.error("getVpnMap failed, VPN {} not present", id.getValue());
 212         return null;
 213     }
 214
 215     protected Uuid getVpnForNetwork(Uuid network) {
 216         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 217         Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
 218         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 219             List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
 220             for (VpnMap vpnMap : allMaps) {
 221                 List<Uuid> netIds = vpnMap.getNetworkIds();
 222                 if (netIds != null && netIds.contains(network)) {
 223                     return vpnMap.getVpnId();
 224                 }
 225             }
 226         }
 227         LOG.debug("getVpnForNetwork: Failed for network {} as no VPN present in VPNMaps DS", network.getValue());
 228         return null;
 229     }
 230
 231     protected Uuid getVpnForSubnet(Uuid subnetId) {
 232         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 233         Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
 234                 subnetmapIdentifier);
 235         if (optionalSubnetMap.isPresent()) {
 236             return optionalSubnetMap.get().getVpnId();
 237         }
 238         LOG.error("getVpnForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
 239         return null;
 240     }
 241
 242     protected Uuid getNetworkForSubnet(Uuid subnetId) {
 243         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 244         Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
 245                 subnetmapIdentifier);
 246         if (optionalSubnetMap.isPresent()) {
 247             return optionalSubnetMap.get().getNetworkId();
 248         }
 249         LOG.error("getNetworkForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
 250         return null;
 251     }
 252
 253     // @param external vpn - true if external vpn being fetched, false for internal vpn
 254     protected Uuid getVpnForRouter(Uuid routerId, Boolean externalVpn) {
 255         if (routerId == null) {
 256             return null;
 257         }
 258
 259         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 260         Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
 261         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 262             List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
 263             for (VpnMap vpnMap : allMaps) {
 264                 if (routerId.equals(vpnMap.getRouterId())) {
 265                     if (externalVpn) {
 266                         if (!routerId.equals(vpnMap.getVpnId())) {
 267                             return vpnMap.getVpnId();
 268                         }
 269                     } else {
 270                         if (routerId.equals(vpnMap.getVpnId())) {
 271                             return vpnMap.getVpnId();
 272                         }
 273                     }
 274                 }
 275             }
 276         }
 277         LOG.debug("getVpnForRouter: Failed for router {} as no VPN present in VPNMaps DS", routerId.getValue());
 278         return null;
 279     }
 280
 281     protected Uuid getRouterforVpn(Uuid vpnId) {
 282         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 283                 new VpnMapKey(vpnId)).build();
 284         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 285         if (optionalVpnMap.isPresent()) {
 286             VpnMap vpnMap = optionalVpnMap.get();
 287             return vpnMap.getRouterId();
 288         }
 289         LOG.error("getRouterforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
 290         return null;
 291     }
 292
 293     protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
 294         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 295                 new VpnMapKey(vpnId)).build();
 296         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 297         if (optionalVpnMap.isPresent()) {
 298             VpnMap vpnMap = optionalVpnMap.get();
 299             return vpnMap.getNetworkIds();
 300         }
 301         LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
 302         return null;
 303     }
 304
 305     protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
 306         List<Uuid> subnets = new ArrayList<>();
 307         // read subnetmaps
 308         InstanceIdentifier<Subnetmaps> subnetmapsid = InstanceIdentifier.builder(Subnetmaps.class).build();
 309         Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, subnetmapsid);
 310         if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
 311             List<Subnetmap> subnetMapList = subnetmaps.get().getSubnetmap();
 312             for (Subnetmap candidateSubnetMap : subnetMapList) {
 313                 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
 314                     subnets.add(candidateSubnetMap.getId());
 315                 }
 316             }
 317         }
 318         return subnets;
 319     }
 320
 321     protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
 322         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 323         Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
 324         if (vpnPortipToPortData.isPresent()) {
 325             return vpnPortipToPortData.get().getPortName();
 326         }
 327         LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
 328                 + " fixed IP {}", vpnName, fixedIp);
 329         return null;
 330     }
 331
 332     protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
 333         InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
 334         Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
 335         if (optionalNetworkMap.isPresent()) {
 336             return optionalNetworkMap.get().getSubnetIdList();
 337         }
 338         LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
 339         return null;
 340     }
 341
 342     protected List<Uuid> getPortIdsFromSubnetId(Uuid subnetId) {
 343         InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
 344         Optional<Subnetmap> optionalSubnetmap = read(LogicalDatastoreType.CONFIGURATION, id);
 345         if (optionalSubnetmap.isPresent()) {
 346             return optionalSubnetmap.get().getPortList();
 347         }
 348         return null;
 349     }
 350
 351     protected Router getNeutronRouter(Uuid routerId) {
 352         Router router = routerMap.get(routerId);
 353         if (router != null) {
 354             return router;
 355         }
 356         InstanceIdentifier<Router> inst = InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
 357                 .class, new RouterKey(routerId));
 358         Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, inst);
 359         if (rtr.isPresent()) {
 360             router = rtr.get();
 361         }
 362         return router;
 363     }
 364
 365     protected Network getNeutronNetwork(Uuid networkId) {
 366         Network network = null;
 367         network = networkMap.get(networkId);
 368         if (network != null) {
 369             return network;
 370         }
 371         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
 372         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(Networks.class)
 373             .child(Network.class, new NetworkKey(networkId));
 374         Optional<Network> net = read(LogicalDatastoreType.CONFIGURATION, inst);
 375         if (net.isPresent()) {
 376             network = net.get();
 377         }
 378         return network;
 379     }
 380
 381     protected Port getNeutronPort(Uuid portId) {
 382         Port prt = portMap.get(portId);
 383         if (prt != null) {
 384             return prt;
 385         }
 386         LOG.debug("getNeutronPort for {}", portId.getValue());
 387         InstanceIdentifier<Port> inst = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(Port.class,
 388                 new PortKey(portId));
 389         Optional<Port> port = read(LogicalDatastoreType.CONFIGURATION, inst);
 390         if (port.isPresent()) {
 391             prt = port.get();
 392         }
 393         return prt;
 394     }
 395
 396     /**
 397      * Returns port_security_enabled status with the port.
 398      *
 399      * @param port the port
 400      * @return port_security_enabled status
 401      */
 402     protected static boolean getPortSecurityEnabled(Port port) {
 403         String deviceOwner = port.getDeviceOwner();
 404         if (deviceOwner != null && deviceOwner.startsWith("network:")) {
 405             // port with device owner of network:xxx is created by
 406             // neutorn for its internal use. So security group doesn't apply.
 407             // router interface, dhcp port and floating ip.
 408             return false;
 409         }
 410         PortSecurityExtension portSecurity = port.getAugmentation(PortSecurityExtension.class);
 411         if (portSecurity != null) {
 412             return portSecurity.isPortSecurityEnabled();
 413         }
 414         return false;
 415     }
 416
 417     /**
 418      * Gets security group UUIDs delta   .
 419      *
 420      * @param port1SecurityGroups the port 1 security groups
 421      * @param port2SecurityGroups the port 2 security groups
 422      * @return the security groups delta
 423      */
 424     protected static List<Uuid> getSecurityGroupsDelta(List<Uuid> port1SecurityGroups,
 425             List<Uuid> port2SecurityGroups) {
 426         if (port1SecurityGroups == null) {
 427             return null;
 428         }
 429
 430         if (port2SecurityGroups == null) {
 431             return port1SecurityGroups;
 432         }
 433
 434         List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
 435         List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
 436         for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
 437             Uuid securityGroup1 = iterator.next();
 438             for (Uuid securityGroup2 : list2) {
 439                 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
 440                     iterator.remove();
 441                     break;
 442                 }
 443             }
 444         }
 445         return list1;
 446     }
 447
 448     /**
 449      * Gets the fixed ips delta.
 450      *
 451      * @param port1FixedIps the port 1 fixed ips
 452      * @param port2FixedIps the port 2 fixed ips
 453      * @return the fixed ips delta
 454      */
 455     protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
 456         if (port1FixedIps == null) {
 457             return null;
 458         }
 459
 460         if (port2FixedIps == null) {
 461             return port1FixedIps;
 462         }
 463
 464         List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
 465         List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
 466         for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
 467             FixedIps fixedIps1 = iterator.next();
 468             for (FixedIps fixedIps2 : list2) {
 469                 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
 470                     iterator.remove();
 471                     break;
 472                 }
 473             }
 474         }
 475         return list1;
 476     }
 477
 478     /**
 479      * Gets the allowed address pairs delta.
 480      *
 481      * @param port1AllowedAddressPairs the port 1 allowed address pairs
 482      * @param port2AllowedAddressPairs the port 2 allowed address pairs
 483      * @return the allowed address pairs delta
 484      */
 485     protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
 486         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 487             .AllowedAddressPairs> port1AllowedAddressPairs,
 488         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 489             .AllowedAddressPairs> port2AllowedAddressPairs) {
 490         if (port1AllowedAddressPairs == null) {
 491             return null;
 492         }
 493
 494         if (port2AllowedAddressPairs == null) {
 495             return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
 496         }
 497
 498         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 499             .AllowedAddressPairs> list1 =
 500                 new ArrayList<>(port1AllowedAddressPairs);
 501         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 502             .AllowedAddressPairs> list2 =
 503                 new ArrayList<>(port2AllowedAddressPairs);
 504         for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 505             .AllowedAddressPairs> iterator =
 506              list1.iterator(); iterator.hasNext();) {
 507             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 508                 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
 509             for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 510                      .AllowedAddressPairs allowedAddressPair2 : list2) {
 511                 if (allowedAddressPair1.getKey().equals(allowedAddressPair2.getKey())) {
 512                     iterator.remove();
 513                     break;
 514                 }
 515             }
 516         }
 517         return getAllowedAddressPairsForAclService(list1);
 518     }
 519
 520     /**
 521      * Gets the acl allowed address pairs.
 522      *
 523      * @param macAddress the mac address
 524      * @param ipAddress the ip address
 525      * @return the acl allowed address pairs
 526      */
 527     protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
 528             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
 529         AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
 530         aclAllowedAdressPairBuilder.setMacAddress(macAddress);
 531         if (ipAddress != null && ipAddress.getValue() != null) {
 532             if (ipAddress.getIpPrefix() != null) {
 533                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
 534             } else {
 535                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
 536             }
 537         }
 538         return aclAllowedAdressPairBuilder.build();
 539     }
 540
 541     /**
 542      * Gets the allowed address pairs for acl service.
 543      *
 544      * @param macAddress the mac address
 545      * @param fixedIps the fixed ips
 546      * @return the allowed address pairs for acl service
 547      */
 548     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
 549             List<FixedIps> fixedIps) {
 550         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 551         for (FixedIps fixedIp : fixedIps) {
 552             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
 553                     new org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress(
 554                             fixedIp.getIpAddress().getValue())));
 555         }
 556         return aclAllowedAddressPairs;
 557     }
 558
 559     /**
 560      * Gets the allowed address pairs for acl service.
 561      *
 562      * @param portAllowedAddressPairs the port allowed address pairs
 563      * @return the allowed address pairs for acl service
 564      */
 565     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
 566         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 567             .AllowedAddressPairs> portAllowedAddressPairs) {
 568         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 569         for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
 570                  portAllowedAddressPair : portAllowedAddressPairs) {
 571             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
 572                 portAllowedAddressPair.getIpAddress()));
 573         }
 574         return aclAllowedAddressPairs;
 575     }
 576
 577     /**
 578      * Gets the IPv6 Link Local Address corresponding to the MAC Address.
 579      *
 580      * @param macAddress the mac address
 581      * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
 582      */
 583     protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
 584         IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
 585         return getAclAllowedAddressPairs(macAddress,
 586                 new org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress(
 587                         ipv6LinkLocalAddress.getValue()));
 588     }
 589
 590     /**
 591      * Gets the updated security groups.
 592      *
 593      * @param aclInterfaceSecurityGroups the acl interface security groups
 594      * @param origSecurityGroups the orig security groups
 595      * @param newSecurityGroups the new security groups
 596      * @return the updated security groups
 597      */
 598     protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
 599             List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
 600         List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
 601         List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
 602         List<Uuid> updatedSecurityGroups =
 603                 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
 604         if (addedGroups != null) {
 605             updatedSecurityGroups.addAll(addedGroups);
 606         }
 607         if (deletedGroups != null) {
 608             updatedSecurityGroups.removeAll(deletedGroups);
 609         }
 610         return updatedSecurityGroups;
 611     }
 612
 613     /**
 614      * Gets the allowed address pairs for fixed ips.
 615      *
 616      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 617      * @param portMacAddress the port mac address
 618      * @param origFixedIps the orig fixed ips
 619      * @param newFixedIps the new fixed ips
 620      * @return the allowed address pairs for fixed ips
 621      */
 622     protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
 623             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
 624             List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
 625         List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
 626         List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
 627         List<AllowedAddressPairs> updatedAllowedAddressPairs =
 628             aclInterfaceAllowedAddressPairs != null
 629                 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 630         if (deletedFixedIps != null) {
 631             updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
 632         }
 633         if (addedFixedIps != null) {
 634             updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
 635         }
 636         return updatedAllowedAddressPairs;
 637     }
 638
 639     /**
 640      * Gets the updated allowed address pairs.
 641      *
 642      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 643      * @param origAllowedAddressPairs the orig allowed address pairs
 644      * @param newAllowedAddressPairs the new allowed address pairs
 645      * @return the updated allowed address pairs
 646      */
 647     protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
 648             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
 649             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 650                 .AllowedAddressPairs> origAllowedAddressPairs,
 651             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 652                 .AllowedAddressPairs> newAllowedAddressPairs) {
 653         List<AllowedAddressPairs> addedAllowedAddressPairs =
 654             getAllowedAddressPairsDelta(newAllowedAddressPairs,origAllowedAddressPairs);
 655         List<AllowedAddressPairs> deletedAllowedAddressPairs =
 656             getAllowedAddressPairsDelta(origAllowedAddressPairs, newAllowedAddressPairs);
 657         List<AllowedAddressPairs> updatedAllowedAddressPairs =
 658             aclInterfaceAllowedAddressPairs != null
 659                 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 660         if (addedAllowedAddressPairs != null) {
 661             updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
 662         }
 663         if (deletedAllowedAddressPairs != null) {
 664             updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
 665         }
 666         return updatedAllowedAddressPairs;
 667     }
 668
 669     /**
 670      * Populate interface acl builder.
 671      *
 672      * @param interfaceAclBuilder the interface acl builder
 673      * @param port the port
 674      */
 675     protected static void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
 676         // Handle security group enabled
 677         List<Uuid> securityGroups = port.getSecurityGroups();
 678         if (securityGroups != null) {
 679             interfaceAclBuilder.setSecurityGroups(securityGroups);
 680         }
 681         List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
 682                 port.getMacAddress(), port.getFixedIps());
 683         // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
 684         aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
 685         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
 686             portAllowedAddressPairs = port.getAllowedAddressPairs();
 687         if (portAllowedAddressPairs != null) {
 688             aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
 689         }
 690         interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
 691     }
 692
 693     protected void populateSubnetIpPrefixes(Port port) {
 694         List<IpPrefixOrAddress> subnetIpPrefixes = getSubnetIpPrefixes(port);
 695         if (subnetIpPrefixes != null) {
 696             String portId = port.getUuid().getValue();
 697             InstanceIdentifier<PortSubnetIpPrefixes> portSubnetIpPrefixIdentifier =
 698                 NeutronvpnUtils.buildPortSubnetIpPrefixIdentifier(portId);
 699             PortSubnetIpPrefixesBuilder subnetIpPrefixesBuilder = new PortSubnetIpPrefixesBuilder()
 700                     .setKey(new PortSubnetIpPrefixesKey(portId)).setPortId(portId)
 701                     .setSubnetIpPrefixes(subnetIpPrefixes);
 702             MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL, portSubnetIpPrefixIdentifier,
 703                     subnetIpPrefixesBuilder.build());
 704             LOG.debug("Created Subnet IP Prefixes for port {}", port.getUuid().getValue());
 705         }
 706     }
 707
 708     protected List<IpPrefixOrAddress> getSubnetIpPrefixes(Port port) {
 709         List<Uuid> subnetIds = getSubnetIdsFromNetworkId(port.getNetworkId());
 710         if (subnetIds == null) {
 711             LOG.error("Failed to get Subnet Ids for the Network {}", port.getNetworkId());
 712             return null;
 713         }
 714         List<IpPrefixOrAddress> subnetIpPrefixes = new ArrayList<>();
 715         for (Uuid subnetId : subnetIds) {
 716             Subnet subnet = getNeutronSubnet(subnetId);
 717             if (subnet != null) {
 718                 subnetIpPrefixes.add(new IpPrefixOrAddress(subnet.getCidr()));
 719             }
 720         }
 721         return subnetIpPrefixes;
 722     }
 723
 724     protected Subnet getNeutronSubnet(Uuid subnetId) {
 725         Subnet subnet = subnetMap.get(subnetId);
 726         if (subnet != null) {
 727             return subnet;
 728         }
 729         InstanceIdentifier<Subnet> inst = InstanceIdentifier.create(Neutron.class).child(Subnets.class).child(Subnet
 730                 .class, new SubnetKey(subnetId));
 731         Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
 732
 733         if (sn.isPresent()) {
 734             subnet = sn.get();
 735         }
 736         return subnet;
 737     }
 738
 739     @Nonnull
 740     protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
 741         LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
 742         List<Uuid> subnetIdList = new ArrayList<>();
 743         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
 744             InstanceIdentifier.builder(Subnetmaps.class).build());
 745         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
 746             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
 747                 if (routerId.equals(subnetmap.getRouterId())) {
 748                     subnetIdList.add(subnetmap.getId());
 749                 }
 750             }
 751         }
 752         LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
 753         return subnetIdList;
 754     }
 755
 756     // TODO Clean up the exception handling and the console output
 757     @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
 758     protected Short getIPPrefixFromPort(Port port) {
 759         try {
 760             Uuid subnetUUID = port.getFixedIps().get(0).getSubnetId();
 761             SubnetKey subnetkey = new SubnetKey(subnetUUID);
 762             InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class).child(Subnets
 763                     .class).child(Subnet.class, subnetkey);
 764             Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
 765             if (subnet.isPresent()) {
 766                 String cidr = String.valueOf(subnet.get().getCidr().getValue());
 767                 // Extract the prefix length from cidr
 768                 String[] parts = cidr.split("/");
 769                 if (parts.length == 2) {
 770                     return Short.valueOf(parts[1]);
 771                 } else {
 772                     LOG.trace("Could not retrieve prefix from subnet CIDR");
 773                 }
 774             } else {
 775                 LOG.trace("Unable to read on subnet datastore");
 776             }
 777         } catch (Exception e) {
 778             LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
 779         }
 780         LOG.error("Failed for port {}", port.getUuid().getValue());
 781         return null;
 782     }
 783
 784     // TODO Clean up the exception handling
 785     @SuppressWarnings("checkstyle:IllegalCatch")
 786     protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
 787             boolean isSubnetIp, WriteTransaction writeConfigTxn) {
 788         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 789         VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
 790             .setKey(new VpnPortipToPortKey(fixedIp, vpnName))
 791             .setVpnName(vpnName).setPortFixedip(fixedIp)
 792             .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
 793         try {
 794             if (writeConfigTxn != null) {
 795                 writeConfigTxn.put(LogicalDatastoreType.CONFIGURATION, id, builder.build());
 796             } else {
 797                 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
 798             }
 799             LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
 800                 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
 801         } catch (Exception e) {
 802             LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 803                     e);
 804         }
 805     }
 806
 807     // TODO Clean up the exception handling
 808     @SuppressWarnings("checkstyle:IllegalCatch")
 809     protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp, WriteTransaction writeConfigTxn) {
 810         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 811         try {
 812             if (writeConfigTxn != null) {
 813                 writeConfigTxn.delete(LogicalDatastoreType.CONFIGURATION, id);
 814             } else {
 815                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
 816             }
 817             LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
 818                     vpnName);
 819         } catch (Exception e) {
 820             LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 821                     e);
 822         }
 823     }
 824
 825     // TODO Clean up the exception handling
 826     @SuppressWarnings("checkstyle:IllegalCatch")
 827     protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
 828         InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
 829         try {
 830             synchronized ((vpnName + fixedIp).intern()) {
 831                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
 832             }
 833             LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
 834                     vpnName);
 835         } catch (Exception e) {
 836             LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
 837                 vpnName, fixedIp, e);
 838         }
 839     }
 840
 841     public void addToNetworkCache(Network network) {
 842         networkMap.put(network.getUuid(), network);
 843     }
 844
 845     public void removeFromNetworkCache(Network network) {
 846         networkMap.remove(network.getUuid());
 847     }
 848
 849     public void addToRouterCache(Router router) {
 850         routerMap.put(router.getUuid(), router);
 851     }
 852
 853     public void removeFromRouterCache(Router router) {
 854         routerMap.remove(router.getUuid());
 855     }
 856
 857     public Collection<Router> getAllRouters() {
 858         return routerMap.values();
 859     }
 860
 861     public void addToPortCache(Port port) {
 862         portMap.put(port.getUuid(), port);
 863     }
 864
 865     public void removeFromPortCache(Port port) {
 866         portMap.remove(port.getUuid());
 867     }
 868
 869     public void addToSubnetCache(Subnet subnet) {
 870         subnetMap.put(subnet.getUuid(), subnet);
 871         IpAddress gatewayIp = subnet.getGatewayIp();
 872         if (gatewayIp != null) {
 873             subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
 874         }
 875     }
 876
 877     public void removeFromSubnetCache(Subnet subnet) {
 878         subnetMap.remove(subnet.getUuid());
 879         IpAddress gatewayIp = subnet.getGatewayIp();
 880         if (gatewayIp != null) {
 881             Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
 882             if (gwIps != null) {
 883                 gwIps.remove(subnet.getUuid());
 884             }
 885         }
 886     }
 887
 888     public static String getSegmentationIdFromNeutronNetwork(Network network) {
 889         String segmentationId = null;
 890         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 891         if (providerExtension != null) {
 892             Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
 893             segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
 894         }
 895
 896         return segmentationId;
 897     }
 898
 899     public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
 900         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 901         return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
 902     }
 903
 904     public static String getPhysicalNetworkName(Network network) {
 905         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 906         return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
 907     }
 908
 909     public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
 910         return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
 911     }
 912
 913     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
 914         InstanceIdentifier<VpnPortipToPort> id =
 915             InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
 916                 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
 917         return id;
 918     }
 919
 920     static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
 921         InstanceIdentifier<LearntVpnVipToPort> id =
 922             InstanceIdentifier.builder(LearntVpnVipToPortData.class)
 923                 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
 924         return id;
 925     }
 926
 927     static Boolean getIsExternal(Network network) {
 928         return network.getAugmentation(NetworkL3Extension.class) != null
 929                 && network.getAugmentation(NetworkL3Extension.class).isExternal();
 930     }
 931
 932     public void addToQosPolicyCache(QosPolicy qosPolicy) {
 933         qosPolicyMap.put(qosPolicy.getUuid(),qosPolicy);
 934     }
 935
 936     public void removeFromQosPolicyCache(QosPolicy qosPolicy) {
 937         qosPolicyMap.remove(qosPolicy.getUuid());
 938     }
 939
 940     public void addToQosPortsCache(Uuid qosUuid, Port port) {
 941         if (qosPortsMap.containsKey(qosUuid)) {
 942             if (!qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
 943                 qosPortsMap.get(qosUuid).put(port.getUuid(), port);
 944             }
 945         } else {
 946             HashMap<Uuid, Port> newPortMap = new HashMap<>();
 947             newPortMap.put(port.getUuid(), port);
 948             qosPortsMap.put(qosUuid, newPortMap);
 949         }
 950     }
 951
 952     public void removeFromQosPortsCache(Uuid qosUuid, Port port) {
 953         if (qosPortsMap.containsKey(qosUuid) && qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
 954             qosPortsMap.get(qosUuid).remove(port.getUuid(), port);
 955         }
 956     }
 957
 958     public void addToQosNetworksCache(Uuid qosUuid, Network network) {
 959         if (qosNetworksMap.containsKey(qosUuid)) {
 960             if (!qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
 961                 qosNetworksMap.get(qosUuid).put(network.getUuid(), network);
 962             }
 963         } else {
 964             HashMap<Uuid, Network> newNetworkMap = new HashMap<>();
 965             newNetworkMap.put(network.getUuid(), network);
 966             qosNetworksMap.put(qosUuid, newNetworkMap);
 967         }
 968     }
 969
 970     public void removeFromQosNetworksCache(Uuid qosUuid, Network network) {
 971         if (qosNetworksMap.containsKey(qosUuid) && qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
 972             qosNetworksMap.get(qosUuid).remove(network.getUuid(), network);
 973         }
 974     }
 975
 976     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
 977         InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
 978                 NetworkMapKey(networkId)).build();
 979         return id;
 980     }
 981
 982     static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
 983         InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
 984                 .class, new VpnInterfaceKey(ifName)).build();
 985         return id;
 986     }
 987
 988     static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
 989         InstanceIdentifier<Subnetmap> id = InstanceIdentifier.builder(Subnetmaps.class).child(Subnetmap.class, new
 990                 SubnetmapKey(subnetId)).build();
 991         return id;
 992     }
 993
 994     static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
 995         InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
 996                 InterfaceKey(interfaceName)).build();
 997         return id;
 998     }
 999
1000     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1001             .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1002         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1003                 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1004                 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1005                 .getValue())).build();
1006         return id;
1007     }
1008
1009     static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1010         return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1011                 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1012     }
1013
1014     static InstanceIdentifier<PortSubnetIpPrefixes> buildPortSubnetIpPrefixIdentifier(String portId) {
1015         InstanceIdentifier<PortSubnetIpPrefixes> id = InstanceIdentifier.builder(PortsSubnetIpPrefixes.class)
1016             .child(PortSubnetIpPrefixes.class, new PortSubnetIpPrefixesKey(portId)).build();
1017         return id;
1018     }
1019
1020     // TODO Remove this method entirely
1021     @SuppressWarnings("checkstyle:IllegalCatch")
1022     private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1023         try {
1024             return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1025         } catch (ReadFailedException e) {
1026             throw new RuntimeException(e);
1027         }
1028     }
1029
1030     public static Class<? extends NetworkTypeBase> getNetworkType(Network network) {
1031         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
1032         return providerExtension != null ? providerExtension.getNetworkType() : null;
1033     }
1034
1035     static ProviderTypes getProviderNetworkType(Network network) {
1036         if (network == null) {
1037             LOG.error("Error in getting provider network type since network is null");
1038             return null;
1039         }
1040         NetworkProviderExtension npe = network.getAugmentation(NetworkProviderExtension.class);
1041         if (npe != null) {
1042             Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1043             if (networkTypeBase != null) {
1044                 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1045                     return ProviderTypes.FLAT;
1046                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1047                     return ProviderTypes.VLAN;
1048                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1049                     return ProviderTypes.VXLAN;
1050                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1051                     return ProviderTypes.GRE;
1052                 }
1053             }
1054         }
1055         LOG.error("Error in getting provider network type since network provider extension is null for network "
1056                 + "{}", network.getUuid().getValue());
1057         return null;
1058     }
1059
1060     static boolean isNetworkTypeSupported(Network network) {
1061         NetworkProviderExtension npe = network.getAugmentation(NetworkProviderExtension.class);
1062         return npe != null && npe.getNetworkType() != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1063     }
1064
1065     static boolean isNetworkOfType(Network network, Class<? extends NetworkTypeBase> type) {
1066         NetworkProviderExtension npe = network.getAugmentation(NetworkProviderExtension.class);
1067         if (npe != null && npe.getNetworkType() != null) {
1068             return type.isAssignableFrom(npe.getNetworkType());
1069         }
1070         return false;
1071     }
1072
1073     static boolean isFlatOrVlanNetwork(Network network) {
1074         return network != null
1075                 && (isNetworkOfType(network, NetworkTypeVlan.class) || isNetworkOfType(network, NetworkTypeFlat.class));
1076     }
1077
1078     static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1079         return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1080     }
1081
1082     /**
1083      * Get inter-VPN link state.
1084      *
1085      * @param vpnLinkName VPN link name
1086      * @return Optional of InterVpnLinkState
1087      */
1088     public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1089         InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1090                 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1091         return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1092     }
1093
1094     /**
1095      * Returns an InterVpnLink by searching by one of its endpoint's IP.
1096      *
1097      * @param endpointIp IP to search for
1098      * @return a InterVpnLink
1099      */
1100     public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1101         InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1102         Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1103                 interVpnLinksIid);
1104         if (interVpnLinksOpData.isPresent()) {
1105             List<InterVpnLink> allInterVpnLinks = interVpnLinksOpData.get().getInterVpnLink();
1106             for (InterVpnLink interVpnLink : allInterVpnLinks) {
1107                 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1108                         || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1109                     return Optional.of(interVpnLink);
1110                 }
1111             }
1112         }
1113         return Optional.absent();
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         StringBuilder interfaceID = new StringBuilder();
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.contains("/")) {
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 a list of Private Subnetmap Ids from router to export then its prefixes in Internet VPN.
1557      * @param extNet Provider Network, which has a port attached as external network gateway to router
1558      * @return a list of Private Subnetmap Ids of the router with external network gateway
1559      */
1560     public @Nonnull List<Uuid> getPrivateSubnetsToExport(@Nonnull Network extNet) {
1561         List<Uuid> subList = new ArrayList<>();
1562         Uuid extNetVpnId = getVpnForNetwork(extNet.getUuid());
1563         if (extNetVpnId == null) {
1564             return subList;
1565         }
1566         Router router = getNeutronRouter(getRouterforVpn(extNetVpnId));
1567         ExternalGatewayInfo info = router.getExternalGatewayInfo();
1568         if (info == null) {
1569             LOG.error("getPrivateSubnetsToExport: can not get info about external gateway for router {}",
1570                       router.getUuid().getValue());
1571             return subList;
1572         }
1573         // check that router really has given provider network as its external gateway port
1574         if (!extNet.getUuid().equals(info.getExternalNetworkId())) {
1575             LOG.error("getPrivateSubnetsToExport: router {} is not attached to given provider network {}",
1576                       router.getUuid().getValue(), extNet.getUuid().getValue());
1577             return subList;
1578         }
1579         return getSubnetsforVpn(router.getUuid());
1580     }
1581
1582     public void updateVpnInstanceWithFallback(String vpnName, boolean add) {
1583         VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName);
1584         if (vpnInstanceOpDataEntry == null) {
1585             // BGPVPN context not found
1586             return;
1587         }
1588         String routerIdUuid = getRouterIdfromVpnInstance(vpnInstanceOpDataEntry.getVrfId());
1589         if (routerIdUuid != null) {
1590             List<BigInteger> dpnIds = getDpnsForRouter(routerIdUuid);
1591             if (!dpnIds.isEmpty()) {
1592                 Long vpnId = vpnInstanceOpDataEntry.getVpnId();
1593                 VpnInstanceOpDataEntry vpnOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(routerIdUuid);
1594                 Long routerIdAsLong = vpnOpDataEntry.getVpnId();
1595                 if (routerIdAsLong == null) {
1596                     return;
1597                 }
1598                 for (BigInteger dpnId : dpnIds) {
1599                     if (add) {
1600                         ipV6InternetDefRt.installDefaultRoute(dpnId, vpnId, routerIdAsLong);
1601                     } else {
1602                         ipV6InternetDefRt.removeDefaultRoute(dpnId, vpnId, routerIdAsLong);
1603                     }
1604                 }
1605             }
1606         }
1607     }
1608
1609     public void updateVpnInstanceOpWithType(VpnInstanceOpDataEntry.BgpvpnType choice, @Nonnull Uuid vpn) {
1610         String primaryRd = getVpnRd(vpn.getValue());
1611         if (primaryRd == null) {
1612             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1613                     + "Primary RD not found", choice, vpn.getValue());
1614             return;
1615         }
1616         InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1617               .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1618
1619         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1620             read(LogicalDatastoreType.OPERATIONAL, id);
1621         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1622             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1623                     + "VpnInstanceOpDataEntry not found", choice, vpn.getValue());
1624             return;
1625         }
1626         VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnInstanceOpDataEntryOptional.get();
1627         if (vpnInstanceOpDataEntry.getBgpvpnType().equals(choice)) {
1628             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1629                     + "VpnInstanceOpDataEntry already set", choice, vpn.getValue());
1630             return;
1631         }
1632         VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1633         builder.setBgpvpnType(choice);
1634         WriteTransaction writeTxn = dataBroker.newWriteOnlyTransaction();
1635         writeTxn.merge(LogicalDatastoreType.OPERATIONAL, id, builder.build(), false);
1636         LOG.debug("updateVpnInstanceOpWithType: sent merge to operDS BgpvpnType {} for {}", choice, vpn.getValue());
1637         try {
1638             writeTxn.submit().get();
1639         } catch (InterruptedException | ExecutionException e) {
1640             LOG.error("updateVpnInstanceOpWithType: on merge execution, error:  {}", e);
1641         }
1642         return;
1643     }
1644
1645     @Nonnull
1646     public List<BigInteger> getDpnsForRouter(String routerUuid) {
1647         InstanceIdentifier id = InstanceIdentifier.builder(NeutronRouterDpns.class)
1648             .child(RouterDpnList.class, new RouterDpnListKey(routerUuid)).build();
1649         Optional<RouterDpnList> routerDpnListData =
1650                 SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1651                         LogicalDatastoreType.OPERATIONAL, id);
1652         List<BigInteger> dpns = new ArrayList<>();
1653         if (routerDpnListData.isPresent()) {
1654             List<DpnVpninterfacesList> dpnVpninterfacesList = routerDpnListData.get().getDpnVpninterfacesList();
1655             for (DpnVpninterfacesList dpnVpnInterface : dpnVpninterfacesList) {
1656                 dpns.add(dpnVpnInterface.getDpnId());
1657             }
1658         }
1659         return dpns;
1660     }
1661
1662     public String getRouterIdfromVpnInstance(String vpnName) {
1663         // returns only router, attached to IPv4 networks
1664         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class)
1665             .child(VpnMap.class, new VpnMapKey(new Uuid(vpnName))).build();
1666         Optional<VpnMap> optionalVpnMap = SingleTransactionDataBroker
1667                 .syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1668                         LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
1669         if (!optionalVpnMap.isPresent()) {
1670             LOG.error("getRouterIdfromVpnInstance : Router not found for vpn : {}", vpnName);
1671             return null;
1672         }
1673         Uuid routerId = optionalVpnMap.get().getRouterId();
1674         if (routerId != null) {
1675             return routerId.getValue();
1676         }
1677         LOG.info("getRouterIdfromVpnInstance : Router not found for vpn : {}", vpnName);
1678         return null;
1679     }
1680
1681     public InstanceIdentifier<Router> buildNeutronRouterIdentifier(Uuid routerUuid) {
1682         InstanceIdentifier<Router> routerInstanceIdentifier = InstanceIdentifier.create(Neutron.class)
1683              .child(Routers.class).child(Router.class, new RouterKey(routerUuid));
1684         return routerInstanceIdentifier;
1685     }
1686 }