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