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