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