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.genius.idmanager.rev160406.ReleaseIdOutput;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.Dhcpv6Base;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpVersionBase;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.PortSubnets;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnet;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnetBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnetKey;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfo;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfoBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfoKey;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnListKey;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnMaps;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMap;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMapKey;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router.ExternalGatewayInfo;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
 137 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
 138 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 139 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
 140 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.portsecurity.rev150712.PortSecurityExtension;
 141 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
 142 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.QosPolicy;
 143 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
 144 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
 145 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
 146 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
 147 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinkStates;
 148 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinks;
 149 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
 150 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateKey;
 151 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
 152 import org.opendaylight.yangtools.yang.binding.DataObject;
 153 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 154 import org.opendaylight.yangtools.yang.common.RpcResult;
 155 import org.slf4j.Logger;
 156 import org.slf4j.LoggerFactory;
 157
 158 @Singleton
 159 public class NeutronvpnUtils {
 160
 161     private static final Logger LOG = LoggerFactory.getLogger(NeutronvpnUtils.class);
 162     private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>
 163         NETWORK_MAP =
 164         new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
 165             .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
 166             .put(NetworkTypeGre.class, SegmentTypeGre.class)
 167             .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
 168             .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
 169             .build();
 170
 171     private static final Set<Class<? extends NetworkTypeBase>> SUPPORTED_NETWORK_TYPES = new HashSet<>();
 172
 173     static {
 174         SUPPORTED_NETWORK_TYPES.add(NetworkTypeFlat.class);
 175         SUPPORTED_NETWORK_TYPES.add(NetworkTypeVlan.class);
 176         SUPPORTED_NETWORK_TYPES.add(NetworkTypeVxlan.class);
 177         SUPPORTED_NETWORK_TYPES.add(NetworkTypeGre.class);
 178     }
 179
 180     private final ConcurrentMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
 181     private final ConcurrentMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
 182     private final ConcurrentMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
 183     private final ConcurrentMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
 184     private final Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
 185     private final ConcurrentMap<Uuid, QosPolicy> qosPolicyMap = new ConcurrentHashMap<>();
 186     private final ConcurrentMap<Uuid, HashMap<Uuid, Port>> qosPortsMap = new ConcurrentHashMap<>();
 187     private final ConcurrentMap<Uuid, HashMap<Uuid, Network>> qosNetworksMap = new ConcurrentHashMap<>();
 188
 189     private final DataBroker dataBroker;
 190     private final ManagedNewTransactionRunner txRunner;
 191     private final IdManagerService idManager;
 192     private final JobCoordinator jobCoordinator;
 193     private final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt;
 194
 195     @Inject
 196     public NeutronvpnUtils(final DataBroker dataBroker, final IdManagerService idManager,
 197             final JobCoordinator jobCoordinator, final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt) {
 198         this.dataBroker = dataBroker;
 199         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
 200         this.idManager = idManager;
 201         this.jobCoordinator = jobCoordinator;
 202         this.ipV6InternetDefRt = ipV6InternetDefRt;
 203     }
 204
 205     protected Subnetmap getSubnetmap(Uuid subnetId) {
 206         InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
 207         Optional<Subnetmap> sn = read(LogicalDatastoreType.CONFIGURATION, id);
 208
 209         if (sn.isPresent()) {
 210             return sn.get();
 211         }
 212         LOG.error("getSubnetmap failed, subnet {} is not present", subnetId.getValue());
 213         return null;
 214     }
 215
 216     public VpnMap getVpnMap(Uuid id) {
 217         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 218                 new VpnMapKey(id)).build();
 219         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 220         if (optionalVpnMap.isPresent()) {
 221             return optionalVpnMap.get();
 222         }
 223         LOG.error("getVpnMap failed, VPN {} not present", id.getValue());
 224         return null;
 225     }
 226
 227     protected Uuid getVpnForNetwork(Uuid network) {
 228         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 229         Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
 230         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 231             List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
 232             for (VpnMap vpnMap : allMaps) {
 233                 List<Uuid> netIds = vpnMap.getNetworkIds();
 234                 if (netIds != null && netIds.contains(network)) {
 235                     return vpnMap.getVpnId();
 236                 }
 237             }
 238         }
 239         LOG.debug("getVpnForNetwork: Failed for network {} as no VPN present in VPNMaps DS", network.getValue());
 240         return null;
 241     }
 242
 243     protected Uuid getVpnForSubnet(Uuid subnetId) {
 244         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 245         Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
 246                 subnetmapIdentifier);
 247         if (optionalSubnetMap.isPresent()) {
 248             return optionalSubnetMap.get().getVpnId();
 249         }
 250         LOG.error("getVpnForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
 251         return null;
 252     }
 253
 254     protected Uuid getNetworkForSubnet(Uuid subnetId) {
 255         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 256         Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
 257                 subnetmapIdentifier);
 258         if (optionalSubnetMap.isPresent()) {
 259             return optionalSubnetMap.get().getNetworkId();
 260         }
 261         LOG.error("getNetworkForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
 262         return null;
 263     }
 264
 265     // @param external vpn - true if external vpn being fetched, false for internal vpn
 266     protected Uuid getVpnForRouter(Uuid routerId, Boolean externalVpn) {
 267         if (routerId == null) {
 268             return null;
 269         }
 270
 271         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 272         Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
 273         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 274             List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
 275             for (VpnMap vpnMap : allMaps) {
 276                 if (routerId.equals(vpnMap.getRouterId())) {
 277                     if (externalVpn) {
 278                         if (!routerId.equals(vpnMap.getVpnId())) {
 279                             return vpnMap.getVpnId();
 280                         }
 281                     } else {
 282                         if (routerId.equals(vpnMap.getVpnId())) {
 283                             return vpnMap.getVpnId();
 284                         }
 285                     }
 286                 }
 287             }
 288         }
 289         LOG.debug("getVpnForRouter: Failed for router {} as no VPN present in VPNMaps DS", routerId.getValue());
 290         return null;
 291     }
 292
 293     protected Uuid getRouterforVpn(Uuid vpnId) {
 294         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 295                 new VpnMapKey(vpnId)).build();
 296         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 297         if (optionalVpnMap.isPresent()) {
 298             VpnMap vpnMap = optionalVpnMap.get();
 299             return vpnMap.getRouterId();
 300         }
 301         LOG.error("getRouterforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
 302         return null;
 303     }
 304
 305     protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
 306         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 307                 new VpnMapKey(vpnId)).build();
 308         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 309         if (optionalVpnMap.isPresent()) {
 310             VpnMap vpnMap = optionalVpnMap.get();
 311             return vpnMap.getNetworkIds();
 312         }
 313         LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
 314         return null;
 315     }
 316
 317     protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
 318         List<Uuid> subnets = new ArrayList<>();
 319         // read subnetmaps
 320         InstanceIdentifier<Subnetmaps> subnetmapsid = InstanceIdentifier.builder(Subnetmaps.class).build();
 321         Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, subnetmapsid);
 322         if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
 323             List<Subnetmap> subnetMapList = subnetmaps.get().getSubnetmap();
 324             for (Subnetmap candidateSubnetMap : subnetMapList) {
 325                 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
 326                     subnets.add(candidateSubnetMap.getId());
 327                 }
 328             }
 329         }
 330         return subnets;
 331     }
 332
 333     protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
 334         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 335         Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
 336         if (vpnPortipToPortData.isPresent()) {
 337             return vpnPortipToPortData.get().getPortName();
 338         }
 339         LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
 340                 + " fixed IP {}", vpnName, fixedIp);
 341         return null;
 342     }
 343
 344     protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
 345         InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
 346         Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
 347         if (optionalNetworkMap.isPresent()) {
 348             return optionalNetworkMap.get().getSubnetIdList();
 349         }
 350         LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
 351         return null;
 352     }
 353
 354     protected List<Uuid> getPortIdsFromSubnetId(Uuid subnetId) {
 355         InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
 356         Optional<Subnetmap> optionalSubnetmap = read(LogicalDatastoreType.CONFIGURATION, id);
 357         if (optionalSubnetmap.isPresent()) {
 358             return optionalSubnetmap.get().getPortList();
 359         }
 360         return null;
 361     }
 362
 363     protected Router getNeutronRouter(Uuid routerId) {
 364         Router router = routerMap.get(routerId);
 365         if (router != null) {
 366             return router;
 367         }
 368         InstanceIdentifier<Router> inst = InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
 369                 .class, new RouterKey(routerId));
 370         Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, inst);
 371         if (rtr.isPresent()) {
 372             router = rtr.get();
 373         }
 374         return router;
 375     }
 376
 377     protected Network getNeutronNetwork(Uuid networkId) {
 378         Network network = null;
 379         network = networkMap.get(networkId);
 380         if (network != null) {
 381             return network;
 382         }
 383         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
 384         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(Networks.class)
 385             .child(Network.class, new NetworkKey(networkId));
 386         Optional<Network> net = read(LogicalDatastoreType.CONFIGURATION, inst);
 387         if (net.isPresent()) {
 388             network = net.get();
 389         }
 390         return network;
 391     }
 392
 393     protected Port getNeutronPort(Uuid portId) {
 394         Port prt = portMap.get(portId);
 395         if (prt != null) {
 396             return prt;
 397         }
 398         LOG.debug("getNeutronPort for {}", portId.getValue());
 399         InstanceIdentifier<Port> inst = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(Port.class,
 400                 new PortKey(portId));
 401         Optional<Port> port = read(LogicalDatastoreType.CONFIGURATION, inst);
 402         if (port.isPresent()) {
 403             prt = port.get();
 404         }
 405         return prt;
 406     }
 407
 408     /**
 409      * Returns port_security_enabled status with the port.
 410      *
 411      * @param port the port
 412      * @return port_security_enabled status
 413      */
 414     protected static boolean getPortSecurityEnabled(Port port) {
 415         String deviceOwner = port.getDeviceOwner();
 416         if (deviceOwner != null && deviceOwner.startsWith("network:")) {
 417             // port with device owner of network:xxx is created by
 418             // neutorn for its internal use. So security group doesn't apply.
 419             // router interface, dhcp port and floating ip.
 420             return false;
 421         }
 422         PortSecurityExtension portSecurity = port.getAugmentation(PortSecurityExtension.class);
 423         if (portSecurity != null) {
 424             return portSecurity.isPortSecurityEnabled();
 425         }
 426         return false;
 427     }
 428
 429     /**
 430      * Gets security group UUIDs delta   .
 431      *
 432      * @param port1SecurityGroups the port 1 security groups
 433      * @param port2SecurityGroups the port 2 security groups
 434      * @return the security groups delta
 435      */
 436     protected static List<Uuid> getSecurityGroupsDelta(List<Uuid> port1SecurityGroups,
 437             List<Uuid> port2SecurityGroups) {
 438         if (port1SecurityGroups == null) {
 439             return null;
 440         }
 441
 442         if (port2SecurityGroups == null) {
 443             return port1SecurityGroups;
 444         }
 445
 446         List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
 447         List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
 448         for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
 449             Uuid securityGroup1 = iterator.next();
 450             for (Uuid securityGroup2 : list2) {
 451                 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
 452                     iterator.remove();
 453                     break;
 454                 }
 455             }
 456         }
 457         return list1;
 458     }
 459
 460     /**
 461      * Gets the fixed ips delta.
 462      *
 463      * @param port1FixedIps the port 1 fixed ips
 464      * @param port2FixedIps the port 2 fixed ips
 465      * @return the fixed ips delta
 466      */
 467     protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
 468         if (port1FixedIps == null) {
 469             return null;
 470         }
 471
 472         if (port2FixedIps == null) {
 473             return port1FixedIps;
 474         }
 475
 476         List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
 477         List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
 478         for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
 479             FixedIps fixedIps1 = iterator.next();
 480             for (FixedIps fixedIps2 : list2) {
 481                 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
 482                     iterator.remove();
 483                     break;
 484                 }
 485             }
 486         }
 487         return list1;
 488     }
 489
 490     /**
 491      * Gets the allowed address pairs delta.
 492      *
 493      * @param port1AllowedAddressPairs the port 1 allowed address pairs
 494      * @param port2AllowedAddressPairs the port 2 allowed address pairs
 495      * @return the allowed address pairs delta
 496      */
 497     protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
 498         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 499             .AllowedAddressPairs> port1AllowedAddressPairs,
 500         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 501             .AllowedAddressPairs> port2AllowedAddressPairs) {
 502         if (port1AllowedAddressPairs == null) {
 503             return null;
 504         }
 505
 506         if (port2AllowedAddressPairs == null) {
 507             return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
 508         }
 509
 510         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 511             .AllowedAddressPairs> list1 =
 512                 new ArrayList<>(port1AllowedAddressPairs);
 513         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 514             .AllowedAddressPairs> list2 =
 515                 new ArrayList<>(port2AllowedAddressPairs);
 516         for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 517             .AllowedAddressPairs> iterator =
 518              list1.iterator(); iterator.hasNext();) {
 519             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 520                 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
 521             for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 522                      .AllowedAddressPairs allowedAddressPair2 : list2) {
 523                 if (allowedAddressPair1.getKey().equals(allowedAddressPair2.getKey())) {
 524                     iterator.remove();
 525                     break;
 526                 }
 527             }
 528         }
 529         return getAllowedAddressPairsForAclService(list1);
 530     }
 531
 532     /**
 533      * Gets the acl allowed address pairs.
 534      *
 535      * @param macAddress the mac address
 536      * @param ipAddress the ip address
 537      * @return the acl allowed address pairs
 538      */
 539     protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
 540             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
 541         AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
 542         aclAllowedAdressPairBuilder.setMacAddress(macAddress);
 543         if (ipAddress != null && ipAddress.getValue() != null) {
 544             if (ipAddress.getIpPrefix() != null) {
 545                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
 546             } else {
 547                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
 548             }
 549         }
 550         return aclAllowedAdressPairBuilder.build();
 551     }
 552
 553     /**
 554      * Gets the allowed address pairs for acl service.
 555      *
 556      * @param macAddress the mac address
 557      * @param fixedIps the fixed ips
 558      * @return the allowed address pairs for acl service
 559      */
 560     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
 561             List<FixedIps> fixedIps) {
 562         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 563         for (FixedIps fixedIp : fixedIps) {
 564             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
 565                     new org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress(
 566                             fixedIp.getIpAddress().getValue())));
 567         }
 568         return aclAllowedAddressPairs;
 569     }
 570
 571     /**
 572      * Gets the allowed address pairs for acl service.
 573      *
 574      * @param portAllowedAddressPairs the port allowed address pairs
 575      * @return the allowed address pairs for acl service
 576      */
 577     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
 578         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 579             .AllowedAddressPairs> portAllowedAddressPairs) {
 580         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 581         for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
 582                  portAllowedAddressPair : portAllowedAddressPairs) {
 583             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
 584                 portAllowedAddressPair.getIpAddress()));
 585         }
 586         return aclAllowedAddressPairs;
 587     }
 588
 589     /**
 590      * Gets the IPv6 Link Local Address corresponding to the MAC Address.
 591      *
 592      * @param macAddress the mac address
 593      * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
 594      */
 595     protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
 596         IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
 597         return getAclAllowedAddressPairs(macAddress,
 598                 new org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress(
 599                         ipv6LinkLocalAddress.getValue()));
 600     }
 601
 602     /**
 603      * Gets the updated security groups.
 604      *
 605      * @param aclInterfaceSecurityGroups the acl interface security groups
 606      * @param origSecurityGroups the orig security groups
 607      * @param newSecurityGroups the new security groups
 608      * @return the updated security groups
 609      */
 610     protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
 611             List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
 612         List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
 613         List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
 614         List<Uuid> updatedSecurityGroups =
 615                 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
 616         if (addedGroups != null) {
 617             updatedSecurityGroups.addAll(addedGroups);
 618         }
 619         if (deletedGroups != null) {
 620             updatedSecurityGroups.removeAll(deletedGroups);
 621         }
 622         return updatedSecurityGroups;
 623     }
 624
 625     /**
 626      * Gets the allowed address pairs for fixed ips.
 627      *
 628      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 629      * @param portMacAddress the port mac address
 630      * @param origFixedIps the orig fixed ips
 631      * @param newFixedIps the new fixed ips
 632      * @return the allowed address pairs for fixed ips
 633      */
 634     protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
 635             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
 636             List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
 637         List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
 638         List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
 639         List<AllowedAddressPairs> updatedAllowedAddressPairs =
 640             aclInterfaceAllowedAddressPairs != null
 641                 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 642         if (deletedFixedIps != null) {
 643             updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
 644         }
 645         if (addedFixedIps != null) {
 646             updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
 647         }
 648         return updatedAllowedAddressPairs;
 649     }
 650
 651     /**
 652      * Gets the updated allowed address pairs.
 653      *
 654      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 655      * @param origAllowedAddressPairs the orig allowed address pairs
 656      * @param newAllowedAddressPairs the new allowed address pairs
 657      * @return the updated allowed address pairs
 658      */
 659     protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
 660             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
 661             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 662                 .AllowedAddressPairs> origAllowedAddressPairs,
 663             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 664                 .AllowedAddressPairs> newAllowedAddressPairs) {
 665         List<AllowedAddressPairs> addedAllowedAddressPairs =
 666             getAllowedAddressPairsDelta(newAllowedAddressPairs,origAllowedAddressPairs);
 667         List<AllowedAddressPairs> deletedAllowedAddressPairs =
 668             getAllowedAddressPairsDelta(origAllowedAddressPairs, newAllowedAddressPairs);
 669         List<AllowedAddressPairs> updatedAllowedAddressPairs =
 670             aclInterfaceAllowedAddressPairs != null
 671                 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 672         if (addedAllowedAddressPairs != null) {
 673             updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
 674         }
 675         if (deletedAllowedAddressPairs != null) {
 676             updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
 677         }
 678         return updatedAllowedAddressPairs;
 679     }
 680
 681     /**
 682      * Populate interface acl builder.
 683      *
 684      * @param interfaceAclBuilder the interface acl builder
 685      * @param port the port
 686      */
 687     protected static void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
 688         // Handle security group enabled
 689         List<Uuid> securityGroups = port.getSecurityGroups();
 690         if (securityGroups != null) {
 691             interfaceAclBuilder.setSecurityGroups(securityGroups);
 692         }
 693         List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
 694                 port.getMacAddress(), port.getFixedIps());
 695         // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
 696         aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
 697         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
 698             portAllowedAddressPairs = port.getAllowedAddressPairs();
 699         if (portAllowedAddressPairs != null) {
 700             aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
 701         }
 702         interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
 703     }
 704
 705     protected void populateSubnetInfo(Port port) {
 706         List<SubnetInfo> portSubnetInfo = getSubnetInfo(port);
 707         if (portSubnetInfo != null) {
 708             String portId = port.getUuid().getValue();
 709             InstanceIdentifier<PortSubnet> portSubnetIdentifier = buildPortSubnetIdentifier(portId);
 710
 711             PortSubnetBuilder portSubnetBuilder = new PortSubnetBuilder().setKey(new PortSubnetKey(portId))
 712                     .setPortId(portId).setSubnetInfo(portSubnetInfo);
 713             try {
 714                 SingleTransactionDataBroker.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL,
 715                         portSubnetIdentifier, portSubnetBuilder.build());
 716             } catch (TransactionCommitFailedException e) {
 717                 LOG.error("Failed to populate subnet info for port={}", portId, e);
 718             }
 719             LOG.debug("Created Subnet info for port={}", portId);
 720         }
 721     }
 722
 723     protected List<SubnetInfo> getSubnetInfo(Port port) {
 724         List<FixedIps> portFixedIps = port.getFixedIps();
 725         if (portFixedIps == null) {
 726             LOG.error("Failed to get Fixed IPs for the port {}", port.getName());
 727             return null;
 728         }
 729         List<SubnetInfo> subnetInfoList = new ArrayList<>();
 730         for (FixedIps portFixedIp : portFixedIps) {
 731             Uuid subnetId = portFixedIp.getSubnetId();
 732             Subnet subnet = getNeutronSubnet(subnetId);
 733             if (subnet != null) {
 734                 Class<? extends IpVersionBase> ipVersion =
 735                         NeutronSecurityRuleConstants.IP_VERSION_MAP.get(subnet.getIpVersion());
 736                 Class<? extends Dhcpv6Base> raMode = subnet.getIpv6RaMode() == null ? null
 737                         : NeutronSecurityRuleConstants.RA_MODE_MAP.get(subnet.getIpv6RaMode());
 738                 SubnetInfo subnetInfo = new SubnetInfoBuilder().setKey(new SubnetInfoKey(subnetId))
 739                         .setIpVersion(ipVersion).setIpPrefix(new IpPrefixOrAddress(subnet.getCidr()))
 740                         .setIpv6RaMode(raMode).setGatewayIp(subnet.getGatewayIp()).build();
 741                 subnetInfoList.add(subnetInfo);
 742             }
 743         }
 744         return subnetInfoList;
 745     }
 746
 747     protected Subnet getNeutronSubnet(Uuid subnetId) {
 748         Subnet subnet = subnetMap.get(subnetId);
 749         if (subnet != null) {
 750             return subnet;
 751         }
 752         InstanceIdentifier<Subnet> inst = InstanceIdentifier.create(Neutron.class).child(Subnets.class).child(Subnet
 753                 .class, new SubnetKey(subnetId));
 754         Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
 755
 756         if (sn.isPresent()) {
 757             subnet = sn.get();
 758         }
 759         return subnet;
 760     }
 761
 762     @Nonnull
 763     protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
 764         LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
 765         List<Uuid> subnetIdList = new ArrayList<>();
 766         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
 767             InstanceIdentifier.builder(Subnetmaps.class).build());
 768         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
 769             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
 770                 if (routerId.equals(subnetmap.getRouterId())) {
 771                     subnetIdList.add(subnetmap.getId());
 772                 }
 773             }
 774         }
 775         LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
 776         return subnetIdList;
 777     }
 778
 779     // TODO Clean up the exception handling and the console output
 780     @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
 781     protected Short getIPPrefixFromPort(Port port) {
 782         try {
 783             Uuid subnetUUID = port.getFixedIps().get(0).getSubnetId();
 784             SubnetKey subnetkey = new SubnetKey(subnetUUID);
 785             InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class).child(Subnets
 786                     .class).child(Subnet.class, subnetkey);
 787             Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
 788             if (subnet.isPresent()) {
 789                 String cidr = String.valueOf(subnet.get().getCidr().getValue());
 790                 // Extract the prefix length from cidr
 791                 String[] parts = cidr.split("/");
 792                 if (parts.length == 2) {
 793                     return Short.valueOf(parts[1]);
 794                 } else {
 795                     LOG.trace("Could not retrieve prefix from subnet CIDR");
 796                 }
 797             } else {
 798                 LOG.trace("Unable to read on subnet datastore");
 799             }
 800         } catch (Exception e) {
 801             LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
 802         }
 803         LOG.error("Failed for port {}", port.getUuid().getValue());
 804         return null;
 805     }
 806
 807     // TODO Clean up the exception handling
 808     @SuppressWarnings("checkstyle:IllegalCatch")
 809     protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
 810             boolean isSubnetIp, WriteTransaction writeConfigTxn) {
 811         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 812         VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
 813             .setKey(new VpnPortipToPortKey(fixedIp, vpnName))
 814             .setVpnName(vpnName).setPortFixedip(fixedIp)
 815             .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
 816         try {
 817             if (writeConfigTxn != null) {
 818                 writeConfigTxn.put(LogicalDatastoreType.CONFIGURATION, id, builder.build());
 819             } else {
 820                 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
 821             }
 822             LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
 823                 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
 824         } catch (Exception e) {
 825             LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 826                     e);
 827         }
 828     }
 829
 830     // TODO Clean up the exception handling
 831     @SuppressWarnings("checkstyle:IllegalCatch")
 832     protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp, WriteTransaction writeConfigTxn) {
 833         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 834         try {
 835             if (writeConfigTxn != null) {
 836                 writeConfigTxn.delete(LogicalDatastoreType.CONFIGURATION, id);
 837             } else {
 838                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
 839             }
 840             LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
 841                     vpnName);
 842         } catch (Exception e) {
 843             LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 844                     e);
 845         }
 846     }
 847
 848     // TODO Clean up the exception handling
 849     @SuppressWarnings("checkstyle:IllegalCatch")
 850     protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
 851         InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
 852         try {
 853             synchronized ((vpnName + fixedIp).intern()) {
 854                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
 855             }
 856             LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
 857                     vpnName);
 858         } catch (Exception e) {
 859             LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
 860                 vpnName, fixedIp, e);
 861         }
 862     }
 863
 864     public void addToNetworkCache(Network network) {
 865         networkMap.put(network.getUuid(), network);
 866     }
 867
 868     public void removeFromNetworkCache(Network network) {
 869         networkMap.remove(network.getUuid());
 870     }
 871
 872     public void addToRouterCache(Router router) {
 873         routerMap.put(router.getUuid(), router);
 874     }
 875
 876     public void removeFromRouterCache(Router router) {
 877         routerMap.remove(router.getUuid());
 878     }
 879
 880     public Collection<Router> getAllRouters() {
 881         return routerMap.values();
 882     }
 883
 884     public void addToPortCache(Port port) {
 885         portMap.put(port.getUuid(), port);
 886     }
 887
 888     public void removeFromPortCache(Port port) {
 889         portMap.remove(port.getUuid());
 890     }
 891
 892     public void addToSubnetCache(Subnet subnet) {
 893         subnetMap.put(subnet.getUuid(), subnet);
 894         IpAddress gatewayIp = subnet.getGatewayIp();
 895         if (gatewayIp != null) {
 896             subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
 897         }
 898     }
 899
 900     public void removeFromSubnetCache(Subnet subnet) {
 901         subnetMap.remove(subnet.getUuid());
 902         IpAddress gatewayIp = subnet.getGatewayIp();
 903         if (gatewayIp != null) {
 904             Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
 905             if (gwIps != null) {
 906                 gwIps.remove(subnet.getUuid());
 907             }
 908         }
 909     }
 910
 911     public static String getSegmentationIdFromNeutronNetwork(Network network) {
 912         String segmentationId = null;
 913         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 914         if (providerExtension != null) {
 915             Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
 916             segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
 917         }
 918
 919         return segmentationId;
 920     }
 921
 922     public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
 923         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 924         return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
 925     }
 926
 927     public static String getPhysicalNetworkName(Network network) {
 928         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
 929         return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
 930     }
 931
 932     public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
 933         return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
 934     }
 935
 936     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
 937         InstanceIdentifier<VpnPortipToPort> id =
 938             InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
 939                 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
 940         return id;
 941     }
 942
 943     static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
 944         InstanceIdentifier<LearntVpnVipToPort> id =
 945             InstanceIdentifier.builder(LearntVpnVipToPortData.class)
 946                 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
 947         return id;
 948     }
 949
 950     static Boolean getIsExternal(Network network) {
 951         return network.getAugmentation(NetworkL3Extension.class) != null
 952                 && network.getAugmentation(NetworkL3Extension.class).isExternal();
 953     }
 954
 955     public void addToQosPolicyCache(QosPolicy qosPolicy) {
 956         qosPolicyMap.put(qosPolicy.getUuid(),qosPolicy);
 957     }
 958
 959     public void removeFromQosPolicyCache(QosPolicy qosPolicy) {
 960         qosPolicyMap.remove(qosPolicy.getUuid());
 961     }
 962
 963     public void addToQosPortsCache(Uuid qosUuid, Port port) {
 964         if (qosPortsMap.containsKey(qosUuid)) {
 965             if (!qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
 966                 qosPortsMap.get(qosUuid).put(port.getUuid(), port);
 967             }
 968         } else {
 969             HashMap<Uuid, Port> newPortMap = new HashMap<>();
 970             newPortMap.put(port.getUuid(), port);
 971             qosPortsMap.put(qosUuid, newPortMap);
 972         }
 973     }
 974
 975     public void removeFromQosPortsCache(Uuid qosUuid, Port port) {
 976         if (qosPortsMap.containsKey(qosUuid) && qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
 977             qosPortsMap.get(qosUuid).remove(port.getUuid(), port);
 978         }
 979     }
 980
 981     public void addToQosNetworksCache(Uuid qosUuid, Network network) {
 982         if (qosNetworksMap.containsKey(qosUuid)) {
 983             if (!qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
 984                 qosNetworksMap.get(qosUuid).put(network.getUuid(), network);
 985             }
 986         } else {
 987             HashMap<Uuid, Network> newNetworkMap = new HashMap<>();
 988             newNetworkMap.put(network.getUuid(), network);
 989             qosNetworksMap.put(qosUuid, newNetworkMap);
 990         }
 991     }
 992
 993     public void removeFromQosNetworksCache(Uuid qosUuid, Network network) {
 994         if (qosNetworksMap.containsKey(qosUuid) && qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
 995             qosNetworksMap.get(qosUuid).remove(network.getUuid(), network);
 996         }
 997     }
 998
 999     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1000         InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1001                 NetworkMapKey(networkId)).build();
1002         return id;
1003     }
1004
1005     static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
1006         InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
1007                 .class, new VpnInterfaceKey(ifName)).build();
1008         return id;
1009     }
1010
1011     static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
1012         InstanceIdentifier<Subnetmap> id = InstanceIdentifier.builder(Subnetmaps.class).child(Subnetmap.class, new
1013                 SubnetmapKey(subnetId)).build();
1014         return id;
1015     }
1016
1017     static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
1018         InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
1019                 InterfaceKey(interfaceName)).build();
1020         return id;
1021     }
1022
1023     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1024             .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1025         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1026                 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1027                 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1028                 .getValue())).build();
1029         return id;
1030     }
1031
1032     static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1033         return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1034                 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1035     }
1036
1037     static InstanceIdentifier<PortSubnet> buildPortSubnetIdentifier(String portId) {
1038         InstanceIdentifier<PortSubnet> id = InstanceIdentifier.builder(PortSubnets.class)
1039                 .child(PortSubnet.class, new PortSubnetKey(portId)).build();
1040         return id;
1041     }
1042
1043     // TODO Remove this method entirely
1044     @SuppressWarnings("checkstyle:IllegalCatch")
1045     private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1046         try {
1047             return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1048         } catch (ReadFailedException e) {
1049             throw new RuntimeException(e);
1050         }
1051     }
1052
1053     public static Class<? extends NetworkTypeBase> getNetworkType(Network network) {
1054         NetworkProviderExtension providerExtension = network.getAugmentation(NetworkProviderExtension.class);
1055         return providerExtension != null ? providerExtension.getNetworkType() : null;
1056     }
1057
1058     static ProviderTypes getProviderNetworkType(Network network) {
1059         if (network == null) {
1060             LOG.error("Error in getting provider network type since network is null");
1061             return null;
1062         }
1063         NetworkProviderExtension npe = network.getAugmentation(NetworkProviderExtension.class);
1064         if (npe != null) {
1065             Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1066             if (networkTypeBase != null) {
1067                 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1068                     return ProviderTypes.FLAT;
1069                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1070                     return ProviderTypes.VLAN;
1071                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1072                     return ProviderTypes.VXLAN;
1073                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1074                     return ProviderTypes.GRE;
1075                 }
1076             }
1077         }
1078         LOG.error("Error in getting provider network type since network provider extension is null for network "
1079                 + "{}", network.getUuid().getValue());
1080         return null;
1081     }
1082
1083     static boolean isNetworkTypeSupported(Network network) {
1084         NetworkProviderExtension npe = network.getAugmentation(NetworkProviderExtension.class);
1085         return npe != null && npe.getNetworkType() != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1086     }
1087
1088     static boolean isNetworkOfType(Network network, Class<? extends NetworkTypeBase> type) {
1089         NetworkProviderExtension npe = network.getAugmentation(NetworkProviderExtension.class);
1090         if (npe != null && npe.getNetworkType() != null) {
1091             return type.isAssignableFrom(npe.getNetworkType());
1092         }
1093         return false;
1094     }
1095
1096     static boolean isFlatOrVlanNetwork(Network network) {
1097         return network != null
1098                 && (isNetworkOfType(network, NetworkTypeVlan.class) || isNetworkOfType(network, NetworkTypeFlat.class));
1099     }
1100
1101     static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1102         return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1103     }
1104
1105     /**
1106      * Get inter-VPN link state.
1107      *
1108      * @param vpnLinkName VPN link name
1109      * @return Optional of InterVpnLinkState
1110      */
1111     public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1112         InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1113                 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1114         return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1115     }
1116
1117     /**
1118      * Returns an InterVpnLink by searching by one of its endpoint's IP.
1119      *
1120      * @param endpointIp IP to search for
1121      * @return a InterVpnLink
1122      */
1123     public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1124         InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1125         Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1126                 interVpnLinksIid);
1127         if (interVpnLinksOpData.isPresent()) {
1128             List<InterVpnLink> allInterVpnLinks = interVpnLinksOpData.get().getInterVpnLink();
1129             for (InterVpnLink interVpnLink : allInterVpnLinks) {
1130                 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1131                         || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1132                     return Optional.of(interVpnLink);
1133                 }
1134             }
1135         }
1136         return Optional.absent();
1137     }
1138
1139     public Set<RouterDpnList> getAllRouterDpnList(BigInteger dpid) {
1140         Set<RouterDpnList> ret = new HashSet<>();
1141         InstanceIdentifier<NeutronRouterDpns> routerDpnId =
1142                 InstanceIdentifier.create(NeutronRouterDpns.class);
1143         Optional<NeutronRouterDpns> neutronRouterDpnsOpt =
1144             MDSALUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, routerDpnId);
1145         if (neutronRouterDpnsOpt.isPresent()) {
1146             NeutronRouterDpns neutronRouterDpns = neutronRouterDpnsOpt.get();
1147             List<RouterDpnList> routerDpnLists = neutronRouterDpns.getRouterDpnList();
1148             for (RouterDpnList routerDpnList : routerDpnLists) {
1149                 if (routerDpnList.getDpnVpninterfacesList() != null) {
1150                     for (DpnVpninterfacesList dpnInterfaceList : routerDpnList.getDpnVpninterfacesList()) {
1151                         if (dpnInterfaceList.getDpnId().equals(dpid)) {
1152                             ret.add(routerDpnList);
1153                         }
1154                     }
1155                 }
1156             }
1157         }
1158         return ret;
1159     }
1160
1161     protected Integer getUniqueRDId(String poolName, String idKey) {
1162         AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1163         try {
1164             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
1165             RpcResult<AllocateIdOutput> rpcResult = result.get();
1166             if (rpcResult.isSuccessful()) {
1167                 return rpcResult.getResult().getIdValue().intValue();
1168             } else {
1169                 LOG.error("RPC call to get unique ID for pool name {} with ID key {} returned with errors {}",
1170                         poolName, idKey, rpcResult.getErrors());
1171             }
1172         } catch (InterruptedException | ExecutionException e) {
1173             LOG.error("Exception when getting Unique Id for poolname {} and ID Key {}", poolName, idKey, e);
1174         }
1175         LOG.error("getUniqueRdId: Failed to return ID for poolname {} and ID Key {}", poolName, idKey);
1176         return null;
1177     }
1178
1179     protected void releaseRDId(String poolName, String idKey) {
1180         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1181         try {
1182             RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).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 }