itm/itm-impl/src/main/java/org/opendaylight/genius/itm/impl/ItmUtils.java

   1 /*
   2  * Copyright © 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 package org.opendaylight.genius.itm.impl;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableMap;
  13 import com.google.common.net.InetAddresses;
  14 import com.google.common.util.concurrent.CheckedFuture;
  15 import com.google.common.util.concurrent.FutureCallback;
  16 import com.google.common.util.concurrent.Futures;
  17 import java.math.BigInteger;
  18 import java.net.InetAddress;
  19 import java.util.ArrayList;
  20 import java.util.Collection;
  21 import java.util.Collections;
  22 import java.util.List;
  23 import java.util.UUID;
  24 import java.util.concurrent.ExecutionException;
  25 import java.util.concurrent.Future;
  26 import org.apache.commons.lang3.StringUtils;
  27 import org.apache.commons.net.util.SubnetUtils;
  28 import org.apache.commons.net.util.SubnetUtils.SubnetInfo;
  29 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  30 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  31 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  32 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  33 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  34 import org.opendaylight.genius.interfacemanager.globals.IfmConstants;
  35 import org.opendaylight.genius.itm.api.IITMProvider;
  36 import org.opendaylight.genius.itm.confighelpers.HwVtep;
  37 import org.opendaylight.genius.itm.globals.ITMConstants;
  38 import org.opendaylight.genius.mdsalutil.ActionInfo;
  39 import org.opendaylight.genius.mdsalutil.FlowEntity;
  40 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  41 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  42 import org.opendaylight.genius.mdsalutil.MatchInfo;
  43 import org.opendaylight.genius.mdsalutil.NwConstants;
  44 import org.opendaylight.genius.mdsalutil.actions.ActionPuntToController;
  45 import org.opendaylight.genius.mdsalutil.instructions.InstructionApplyActions;
  46 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  47 import org.opendaylight.genius.mdsalutil.matches.MatchTunnelId;
  48 import org.opendaylight.genius.utils.cache.DataStoreCache;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlanBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnelBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefsBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelMonitoringTypeBase;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelMonitoringTypeBfd;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.interfaces._interface.NodeIdentifier;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.interfaces._interface.NodeIdentifierBuilder;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.interfaces._interface.NodeIdentifierKey;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorInterval;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorIntervalBuilder;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorParams;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorParamsBuilder;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.VtepConfigSchemas;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.VtepIpPools;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.VtepConfigSchema;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.VtepConfigSchemaBuilder;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.VtepConfigSchemaKey;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.vtep.config.schema.DpnIds;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.vtep.config.schema.DpnIdsBuilder;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.config.schemas.vtep.config.schema.DpnIdsKey;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.ip.pools.VtepIpPool;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.vtep.ip.pools.VtepIpPoolKey;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnEndpoints;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnEndpointsBuilder;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.ExternalTunnelList;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TunnelList;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfo;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfoBuilder;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfoKey;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPoints;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPointsBuilder;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPointsKey;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.tunnel.end.points.TzMembership;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.tunnel.end.points.TzMembershipBuilder;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnel;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnelBuilder;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnelKey;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnel.list.InternalTunnel;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnel.list.InternalTunnelBuilder;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnel.list.InternalTunnelKey;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelListKey;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.DcGatewayIpList;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.TransportZones;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.dc.gateway.ip.list.DcGatewayIp;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TepsNotHostedInTransportZone;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TepsNotHostedInTransportZoneKey;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZone;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneKey;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.Subnets;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.subnets.Vteps;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
 123 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
 124 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
 125 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
 126 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
 127 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
 128 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
 129 import org.opendaylight.yangtools.yang.binding.DataObject;
 130 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 131 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
 132 import org.opendaylight.yangtools.yang.common.RpcResult;
 133 import org.slf4j.Logger;
 134 import org.slf4j.LoggerFactory;
 135
 136 public class ItmUtils {
 137
 138     public static final String DUMMY_IP_ADDRESS = "0.0.0.0";
 139     public static final String TUNNEL_TYPE_VXLAN = "VXLAN";
 140     public static final String TUNNEL_TYPE_GRE = "GRE";
 141     public static final String TUNNEL = "tun";
 142     public static final IpPrefix DUMMY_IP_PREFIX = new IpPrefix(
 143         ITMConstants.DUMMY_PREFIX.toCharArray());
 144     public static ItmCache itmCache = new ItmCache();
 145
 146     private static final Logger LOG = LoggerFactory.getLogger(ItmUtils.class);
 147
 148     public static final ImmutableMap<String, Class<? extends TunnelTypeBase>>
 149         TUNNEL_TYPE_MAP =
 150         new ImmutableMap.Builder<String, Class<? extends TunnelTypeBase>>()
 151             .put(ITMConstants.TUNNEL_TYPE_GRE, TunnelTypeGre.class)
 152             .put(ITMConstants.TUNNEL_TYPE_MPLSoGRE, TunnelTypeMplsOverGre.class)
 153             .put(ITMConstants.TUNNEL_TYPE_VXLAN, TunnelTypeVxlan.class)
 154             .build();
 155
 156     public static final FutureCallback<Void> DEFAULT_CALLBACK = new FutureCallback<Void>() {
 157         @Override
 158         public void onSuccess(Void result) {
 159             LOG.debug("Success in Datastore write operation");
 160         }
 161
 162         @Override
 163         public void onFailure(Throwable error) {
 164             LOG.error("Error in Datastore write operation", error);
 165         }
 166     };
 167
 168     public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
 169                                                           InstanceIdentifier<T> path, DataBroker broker) {
 170         try (ReadOnlyTransaction tx = broker.newReadOnlyTransaction()) {
 171             return tx.read(datastoreType, path).get();
 172         } catch (Exception e) {
 173             throw new RuntimeException(e);
 174         }
 175     }
 176
 177     public static <T extends DataObject> void asyncWrite(LogicalDatastoreType datastoreType,
 178                                                          InstanceIdentifier<T> path, T data, DataBroker broker, FutureCallback<Void> callback) {
 179         WriteTransaction tx = broker.newWriteOnlyTransaction();
 180         tx.put(datastoreType, path, data, true);
 181         Futures.addCallback(tx.submit(), callback);
 182     }
 183
 184     public static <T extends DataObject> void asyncUpdate(LogicalDatastoreType datastoreType,
 185                                                           InstanceIdentifier<T> path, T data, DataBroker broker, FutureCallback<Void> callback) {
 186         WriteTransaction tx = broker.newWriteOnlyTransaction();
 187         tx.merge(datastoreType, path, data, true);
 188         Futures.addCallback(tx.submit(), callback);
 189     }
 190
 191     public static <T extends DataObject> void asyncDelete(LogicalDatastoreType datastoreType,
 192                                                           InstanceIdentifier<T> path, DataBroker broker, FutureCallback<Void> callback) {
 193         WriteTransaction tx = broker.newWriteOnlyTransaction();
 194         tx.delete(datastoreType, path);
 195         Futures.addCallback(tx.submit(), callback);
 196     }
 197     public static <T extends DataObject> void asyncBulkRemove(final DataBroker broker,final LogicalDatastoreType datastoreType,
 198                                                               List<InstanceIdentifier<T>> pathList, FutureCallback<Void> callback) {
 199         if (!pathList.isEmpty()) {
 200             WriteTransaction tx = broker.newWriteOnlyTransaction();
 201             for (InstanceIdentifier<T> path : pathList) {
 202                 tx.delete(datastoreType, path);
 203             }
 204             Futures.addCallback(tx.submit(), callback);
 205         }
 206     }
 207
 208     public static String getInterfaceName(final BigInteger datapathid, final String portName, final Integer vlanId) {
 209         return String.format("%s:%s:%s", datapathid, portName, vlanId);
 210     }
 211
 212     public static BigInteger getDpnIdFromInterfaceName(String interfaceName) {
 213         String[] dpnStr = interfaceName.split(":");
 214         BigInteger dpnId = new BigInteger(dpnStr[0]);
 215         return dpnId;
 216     }
 217
 218     public static String getTrunkInterfaceName(IdManagerService idManager, String parentInterfaceName,
 219                                                String localHostName, String remoteHostName, String tunnelType) {
 220         String tunnelTypeStr;
 221         if(tunnelType.contains("TunnelTypeGre")) {
 222             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_GRE;
 223         } else {
 224             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_VXLAN;
 225         }
 226         String trunkInterfaceName = String.format(  "%s:%s:%s:%s", parentInterfaceName, localHostName,
 227                 remoteHostName, tunnelTypeStr);
 228         LOG.trace("trunk interface name is {}", trunkInterfaceName);
 229         trunkInterfaceName = String.format("%s%s", TUNNEL, getUniqueIdString(trunkInterfaceName));
 230         return trunkInterfaceName;
 231     }
 232
 233     public static void releaseIdForTrunkInterfaceName(IdManagerService idManager, String parentInterfaceName, String localHostName, String remoteHostName, String tunnelType) {
 234         String tunnelTypeStr;
 235         if(tunnelType.contains("TunnelTypeGre")) {
 236             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_GRE;
 237         } else {
 238             tunnelTypeStr = ITMConstants.TUNNEL_TYPE_VXLAN;
 239         }
 240         String trunkInterfaceName = String.format("%s:%s:%s:%s", parentInterfaceName, localHostName, remoteHostName, tunnelTypeStr);
 241         LOG.trace("Releasing Id for trunkInterface - {}", trunkInterfaceName );
 242         //releaseId(idManager, trunkInterfaceName) ;
 243     }
 244
 245     public static InetAddress getInetAddressFromIpAddress(IpAddress ip) {
 246         return InetAddresses.forString(ip.getIpv4Address().getValue());
 247     }
 248
 249     public static InstanceIdentifier<DPNTEPsInfo> getDPNTEPInstance(BigInteger dpIdKey) {
 250         InstanceIdentifier.InstanceIdentifierBuilder<DPNTEPsInfo> dpnTepInfoBuilder =
 251                 InstanceIdentifier.builder(DpnEndpoints.class).child(DPNTEPsInfo.class,
 252                         new DPNTEPsInfoKey(dpIdKey));
 253         InstanceIdentifier<DPNTEPsInfo> dpnInfo = dpnTepInfoBuilder.build();
 254         return dpnInfo;
 255     }
 256
 257     public static DPNTEPsInfo createDPNTepInfo(BigInteger dpId, List<TunnelEndPoints> endpoints) {
 258
 259         return new DPNTEPsInfoBuilder().setKey(new DPNTEPsInfoKey(dpId)).setTunnelEndPoints(endpoints).build();
 260     }
 261
 262     public static TunnelEndPoints createTunnelEndPoints(BigInteger dpnId, IpAddress ipAddress, String portName,
 263                                                         boolean isOfTunnel, int vlanId, IpPrefix prefix,
 264                                                         IpAddress gwAddress, List<TzMembership> zones,
 265                                                         Class<? extends TunnelTypeBase>  tunnel_type) {
 266         // when Interface Mgr provides support to take in Dpn Id
 267         return new TunnelEndPointsBuilder().setKey(new TunnelEndPointsKey(ipAddress, portName,tunnel_type, vlanId))
 268                 .setSubnetMask(prefix).setGwIpAddress(gwAddress).setTzMembership(zones)
 269                 .setOptionOfTunnel(isOfTunnel).setInterfaceName(ItmUtils.getInterfaceName(dpnId, portName, vlanId))
 270                 .setTunnelType(tunnel_type).build();
 271     }
 272
 273     public static DpnEndpoints createDpnEndpoints(List<DPNTEPsInfo> dpnTepInfo) {
 274         return new DpnEndpointsBuilder().setDPNTEPsInfo(dpnTepInfo).build();
 275     }
 276
 277     public static InstanceIdentifier<Interface> buildId(String interfaceName) {
 278         InstanceIdentifierBuilder<Interface> idBuilder =
 279                 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
 280         InstanceIdentifier<Interface> id = idBuilder.build();
 281         return id;
 282     }
 283
 284     public static Interface buildTunnelInterface(BigInteger dpn, String ifName, String desc, boolean enabled,
 285                                                  Class<? extends TunnelTypeBase> tunType, IpAddress localIp,
 286                                                  IpAddress remoteIp, IpAddress gatewayIp, Integer vlanId,
 287                                                  boolean internal, Boolean monitorEnabled,
 288                                                  Class<? extends TunnelMonitoringTypeBase> monitorProtocol,
 289                                                  Integer monitorInterval, boolean useOfTunnel) {
 290         InterfaceBuilder builder = new InterfaceBuilder().setKey(new InterfaceKey(ifName)).setName(ifName)
 291                 .setDescription(desc).setEnabled(enabled).setType(Tunnel.class);
 292         ParentRefs parentRefs = new ParentRefsBuilder().setDatapathNodeIdentifier(dpn).build();
 293         builder.addAugmentation(ParentRefs.class, parentRefs);
 294         Long monitoringInterval=null;
 295         if( vlanId > 0) {
 296             IfL2vlan l2vlan = new IfL2vlanBuilder().setVlanId(new VlanId(vlanId)).build();
 297             builder.addAugmentation(IfL2vlan.class, l2vlan);
 298         }
 299         LOG.debug("buildTunnelInterface: monitorProtocol = {} and monitorInterval = {}",monitorProtocol.getName(),monitorInterval);
 300
 301
 302         if(monitorInterval != null) {
 303             monitoringInterval = monitorInterval.longValue();
 304         }
 305
 306         IfTunnel tunnel = new IfTunnelBuilder().setTunnelDestination(remoteIp).setTunnelGateway(gatewayIp)
 307                 .setTunnelSource(localIp).setTunnelInterfaceType(tunType).setInternal(internal)
 308                 .setMonitorEnabled(monitorEnabled).setMonitorProtocol(monitorProtocol)
 309                 .setMonitorInterval(monitoringInterval).setTunnelRemoteIpFlow(useOfTunnel)
 310                 .build();
 311         builder.addAugmentation(IfTunnel.class, tunnel);
 312         return builder.build();
 313     }
 314
 315     public static Interface buildHwTunnelInterface(String tunnelIfName, String desc, boolean enabled, String topo_id,
 316                                                    String node_id, Class<? extends TunnelTypeBase> tunType, IpAddress srcIp, IpAddress destIp,
 317                                                    IpAddress gWIp, Boolean monitor_enabled, Class<? extends TunnelMonitoringTypeBase> monitorProtocol, Integer monitor_interval){
 318         InterfaceBuilder builder = new InterfaceBuilder().setKey(new InterfaceKey(tunnelIfName)).setName(
 319                 tunnelIfName).setDescription(desc).
 320                 setEnabled(enabled).setType(Tunnel.class);
 321         List<NodeIdentifier> nodeIds = new ArrayList<>();
 322         NodeIdentifier hWnode = new NodeIdentifierBuilder().setKey(new NodeIdentifierKey(topo_id)).setTopologyId(
 323                 topo_id).
 324                 setNodeId(node_id).build();
 325         nodeIds.add(hWnode);
 326         ParentRefs parent = new ParentRefsBuilder().setNodeIdentifier(nodeIds).build();
 327         builder.addAugmentation(ParentRefs.class, parent);
 328         Long monitoringInterval = (long) ITMConstants.DEFAULT_MONITOR_INTERVAL;
 329         Boolean monitoringEnabled = true;
 330         Class<? extends TunnelMonitoringTypeBase> monitoringProtocol = ITMConstants.DEFAULT_MONITOR_PROTOCOL;
 331         if(monitor_interval!= null) {
 332             monitoringInterval = monitor_interval.longValue();
 333         }
 334         if(monitor_enabled!=null  ) {
 335             monitoringEnabled = monitor_enabled;
 336         }
 337         if(monitorProtocol!=null) {
 338             monitoringProtocol = monitorProtocol;
 339         }
 340         IfTunnel tunnel = new IfTunnelBuilder().setTunnelDestination(destIp).setTunnelGateway(gWIp).setTunnelSource(
 341                 srcIp).setMonitorEnabled(monitoringEnabled).setMonitorProtocol(monitorProtocol).setMonitorInterval(100L).
 342                 setTunnelInterfaceType(tunType).setInternal(false).build();
 343         builder.addAugmentation(IfTunnel.class, tunnel);
 344         LOG.trace("iftunnel {} built from hwvtep {} ", tunnel, node_id);
 345         return builder.build();
 346     }
 347
 348
 349     public static InternalTunnel buildInternalTunnel( BigInteger srcDpnId, BigInteger dstDpnId,
 350                                                       Class<? extends TunnelTypeBase> tunType,
 351                                                       String trunkInterfaceName) {
 352         InternalTunnel tnl = new InternalTunnelBuilder().setKey(new InternalTunnelKey(dstDpnId, srcDpnId, tunType)).setDestinationDPN(dstDpnId)
 353                 .setSourceDPN(srcDpnId).setTransportType(tunType)
 354                 .setTunnelInterfaceName(trunkInterfaceName).build();
 355         return tnl ;
 356     }
 357
 358     public static ExternalTunnel buildExternalTunnel(String srcNode, String dstNode,
 359                                                      Class<? extends TunnelTypeBase> tunType,
 360                                                      String trunkInterfaceName) {
 361         ExternalTunnel extTnl = new ExternalTunnelBuilder().setKey(
 362                 new ExternalTunnelKey(dstNode, srcNode, tunType))
 363                 .setSourceDevice(srcNode).setDestinationDevice(dstNode)
 364                 .setTunnelInterfaceName(trunkInterfaceName)
 365                 .setTransportType(tunType).build();
 366         return extTnl ;
 367     }
 368
 369     public static List<DPNTEPsInfo> getTunnelMeshInfo(DataBroker dataBroker) {
 370         List<DPNTEPsInfo> dpnTEPs= null ;
 371
 372         // Read the Mesh Information from Cache if not read from the DS
 373         dpnTEPs = getTunnelMeshInfo() ;
 374         if( dpnTEPs != null ) {
 375             return dpnTEPs ;
 376         }
 377
 378         // Read the EndPoint Info from the operational database
 379         InstanceIdentifierBuilder<DpnEndpoints> depBuilder = InstanceIdentifier.builder( DpnEndpoints.class);
 380         InstanceIdentifier<DpnEndpoints> deps = depBuilder.build();
 381         Optional<DpnEndpoints> dpnEps = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, deps, dataBroker);
 382         if (dpnEps.isPresent()) {
 383             DpnEndpoints tn= dpnEps.get() ;
 384             dpnTEPs = tn.getDPNTEPsInfo();
 385             LOG.debug( "Read from CONFIGURATION datastore - No. of Dpns " , dpnTEPs.size() );
 386         } else {
 387             LOG.debug( "No Dpn information in CONFIGURATION datastore "  );
 388         }
 389         return dpnTEPs ;
 390     }
 391
 392     // Reading the Mesh Information from Cache
 393     public static List<DPNTEPsInfo> getTunnelMeshInfo(){
 394         List<DPNTEPsInfo> dpnTepsInfo = null ;
 395         List<Object> values = null ;
 396
 397         values = DataStoreCache.getValues(ITMConstants.DPN_TEPs_Info_CACHE_NAME);
 398         if( values != null ) {
 399             dpnTepsInfo = new ArrayList<>() ;
 400             for( Object value : values ) {
 401                 dpnTepsInfo.add((DPNTEPsInfo)value) ;
 402             }
 403         }
 404         return dpnTepsInfo ;
 405     }
 406
 407     public static int getUniqueId(IdManagerService idManager, String idKey) {
 408         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
 409                 .setPoolName(ITMConstants.ITM_IDPOOL_NAME)
 410                 .setIdKey(idKey).build();
 411
 412         try {
 413             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 414             RpcResult<AllocateIdOutput> rpcResult = result.get();
 415             if(rpcResult.isSuccessful()) {
 416                 return rpcResult.getResult().getIdValue().intValue();
 417             } else {
 418                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 419             }
 420         } catch (InterruptedException | ExecutionException e) {
 421             LOG.warn("Exception when getting Unique Id",e);
 422         }
 423         return 0;
 424     }
 425
 426     public static String getUniqueIdString(String idKey) {
 427         return UUID.nameUUIDFromBytes(idKey.getBytes()).toString().substring(0, 12).replace("-", "");
 428     }
 429
 430     public static void releaseId(IdManagerService idManager, String idKey) {
 431         ReleaseIdInput idInput =
 432                 new ReleaseIdInputBuilder().setPoolName(ITMConstants.ITM_IDPOOL_NAME).setIdKey(idKey).build();
 433         try {
 434             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 435             RpcResult<Void> rpcResult = result.get();
 436             if(!rpcResult.isSuccessful()) {
 437                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 438             }
 439         } catch (InterruptedException | ExecutionException e) {
 440             LOG.warn("Exception when getting Unique Id for key {}", idKey, e);
 441         }
 442     }
 443
 444     public static List<DPNTEPsInfo> getDPNTEPListFromDPNId(DataBroker dataBroker, List<BigInteger> dpnIds) {
 445         List<DPNTEPsInfo> meshedDpnList = getTunnelMeshInfo(dataBroker) ;
 446         List<DPNTEPsInfo> cfgDpnList = new ArrayList<>();
 447         if( null != meshedDpnList) {
 448             for(BigInteger dpnId : dpnIds) {
 449                 for( DPNTEPsInfo teps : meshedDpnList ) {
 450                     if( dpnId.equals(teps.getDPNID())) {
 451                         cfgDpnList.add( teps) ;
 452                     }
 453                 }
 454             }
 455         }
 456         return cfgDpnList;
 457     }
 458
 459     public static void setUpOrRemoveTerminatingServiceTable(BigInteger dpnId, IMdsalApiManager mdsalManager, boolean addFlag) {
 460         String logmsg = addFlag ? "Installing" : "Removing";
 461         LOG.trace( logmsg + " PUNT to Controller flow in DPN {} ", dpnId );
 462         List<ActionInfo> listActionInfo = new ArrayList<>();
 463         listActionInfo.add(new ActionPuntToController());
 464
 465         try {
 466             List<MatchInfo> mkMatches = new ArrayList<>();
 467
 468             mkMatches.add(new MatchTunnelId(BigInteger.valueOf(ITMConstants.LLDP_SERVICE_ID)));
 469
 470             List<InstructionInfo> mkInstructions = new ArrayList<>();
 471             mkInstructions.add(new InstructionApplyActions(listActionInfo));
 472
 473             FlowEntity terminatingServiceTableFlowEntity = MDSALUtil
 474                     .buildFlowEntity(
 475                             dpnId,
 476                             NwConstants.INTERNAL_TUNNEL_TABLE,
 477                             getFlowRef(NwConstants.INTERNAL_TUNNEL_TABLE,
 478                                     ITMConstants.LLDP_SERVICE_ID), 5, String.format("%s:%d","ITM Flow Entry ",ITMConstants.LLDP_SERVICE_ID),
 479                             0, 0, ITMConstants.COOKIE_ITM
 480                                     .add(BigInteger.valueOf(ITMConstants.LLDP_SERVICE_ID)),
 481                             mkMatches, mkInstructions);
 482             if(addFlag) {
 483                 mdsalManager.installFlow(terminatingServiceTableFlowEntity);
 484             } else {
 485                 mdsalManager.removeFlow(terminatingServiceTableFlowEntity);
 486             }
 487         } catch (Exception e) {
 488             LOG.error("Error while setting up Table 36 for {}", dpnId, e);
 489         }
 490     }
 491
 492     private static String getFlowRef(long termSvcTable, int svcId) {
 493         return String.valueOf(termSvcTable) + svcId;
 494     }
 495     public static InstanceIdentifier<VtepConfigSchema> getVtepConfigSchemaIdentifier(String schemaName) {
 496         return InstanceIdentifier.builder(VtepConfigSchemas.class)
 497                 .child(VtepConfigSchema.class, new VtepConfigSchemaKey(schemaName)).build();
 498     }
 499
 500     public static InstanceIdentifier<VtepConfigSchema> getVtepConfigSchemaIdentifier() {
 501         return InstanceIdentifier.builder(VtepConfigSchemas.class).child(VtepConfigSchema.class).build();
 502     }
 503     public static InstanceIdentifier<VtepConfigSchemas> getVtepConfigSchemasIdentifier() {
 504         return InstanceIdentifier.builder(VtepConfigSchemas.class).build();
 505     }
 506     public static InstanceIdentifier<VtepIpPool> getVtepIpPoolIdentifier(String subnetCidr) {
 507         return InstanceIdentifier.builder(VtepIpPools.class).child(VtepIpPool.class, new VtepIpPoolKey(subnetCidr))
 508                 .build();
 509     }
 510     public static VtepConfigSchema validateForAddVtepConfigSchema(VtepConfigSchema schema,
 511                                                                   List<VtepConfigSchema> existingSchemas) {
 512         VtepConfigSchema validSchema = validateVtepConfigSchema(schema);
 513         for (VtepConfigSchema existingSchema : emptyIfNull(existingSchemas)) {
 514             if (!StringUtils.equalsIgnoreCase(schema.getSchemaName(), existingSchema.getSchemaName())
 515                     && schema.getSubnet().equals(existingSchema.getSubnet())) {
 516                 String subnetCidr = getSubnetCidrAsString(schema.getSubnet());
 517                 Preconditions.checkArgument(false, "VTEP schema with subnet [" + subnetCidr +
 518                         "] already exists. Multiple VTEP schemas with same subnet is not allowed.");
 519             }
 520         }
 521         if (isNotEmpty(getDpnIdList(validSchema.getDpnIds()))) {
 522             String tzone = validSchema.getTransportZoneName();
 523             List<BigInteger> lstDpns = getConflictingDpnsAlreadyConfiguredWithTz(validSchema.getSchemaName(), tzone,
 524                     getDpnIdList(validSchema.getDpnIds()), existingSchemas);
 525             if (!lstDpns.isEmpty()) {
 526                 Preconditions.checkArgument(false,
 527                         "DPN's " + lstDpns + " already configured for transport zone " +
 528                                 tzone + ". Only one end point per transport Zone per Dpn is allowed.");
 529             }
 530             if (schema.getTunnelType().equals(TunnelTypeGre.class)){
 531                 validateForSingleGreTep(validSchema.getSchemaName(), getDpnIdList(validSchema.getDpnIds()), existingSchemas);
 532             }
 533         }
 534         return validSchema;
 535     }
 536     private static void validateForSingleGreTep(String schemaName, List<BigInteger> lstDpnsForAdd,
 537                                                 List<VtepConfigSchema> existingSchemas) {
 538         for (VtepConfigSchema existingSchema : emptyIfNull(existingSchemas)) {
 539             if (TunnelTypeGre.class.equals(existingSchema.getTunnelType())
 540                     && !StringUtils.equalsIgnoreCase(schemaName, existingSchema.getSchemaName())) {
 541                 List<BigInteger> lstConflictingDpns = new ArrayList<>(getDpnIdList(existingSchema.getDpnIds()));
 542                 lstConflictingDpns.retainAll(emptyIfNull(lstDpnsForAdd));
 543                 if (!lstConflictingDpns.isEmpty()) {
 544                     String errMsg = "DPN's " + lstConflictingDpns +
 545                             " already configured with GRE TEP. Mutiple GRE TEP's on a single DPN are not allowed.";
 546                     Preconditions.checkArgument(false, errMsg);
 547                 }
 548             }
 549         }
 550     }
 551     public static VtepConfigSchema validateVtepConfigSchema(VtepConfigSchema schema) {
 552         Preconditions.checkNotNull(schema);
 553         Preconditions.checkArgument(StringUtils.isNotBlank(schema.getSchemaName()));
 554         Preconditions.checkArgument(StringUtils.isNotBlank(schema.getPortName()));
 555         Preconditions.checkArgument(schema.getVlanId() >= 0 && schema.getVlanId() < 4095,
 556                 "Invalid VLAN ID, range (0-4094)");
 557         Preconditions.checkArgument(StringUtils.isNotBlank(schema.getTransportZoneName()));
 558         Preconditions.checkNotNull(schema.getSubnet());
 559         String subnetCidr = getSubnetCidrAsString(schema.getSubnet());
 560         SubnetUtils subnetUtils = new SubnetUtils(subnetCidr);
 561         IpAddress gatewayIp = schema.getGatewayIp();
 562         if (gatewayIp != null) {
 563             String strGatewayIp = String.valueOf(gatewayIp.getValue());
 564             if (!strGatewayIp.equals(ITMConstants.DUMMY_IP_ADDRESS) && !subnetUtils.getInfo().isInRange(strGatewayIp)) {
 565                 Preconditions.checkArgument(false, "Gateway IP address " + strGatewayIp +
 566                         " is not in subnet range " + subnetCidr);
 567             }
 568         }
 569         ItmUtils.getExcludeIpAddresses(schema.getExcludeIpFilter(), subnetUtils.getInfo());
 570         return new VtepConfigSchemaBuilder(schema).setTunnelType(schema.getTunnelType()).build();
 571     }
 572     public static String validateTunnelType(String tunnelType) {
 573         if (tunnelType == null) {
 574             tunnelType = ITMConstants.TUNNEL_TYPE_VXLAN;
 575         } else {
 576             tunnelType = StringUtils.upperCase(tunnelType);
 577             String error = "Invalid tunnel type. Valid values: " +
 578                     ITMConstants.TUNNEL_TYPE_VXLAN + " | " + ITMConstants.TUNNEL_TYPE_GRE;
 579             Preconditions.checkArgument(ITMConstants.TUNNEL_TYPE_VXLAN.equals(tunnelType)
 580                     || ITMConstants.TUNNEL_TYPE_GRE.equals(tunnelType), error);
 581         }
 582         return tunnelType;
 583     }
 584     private static List<BigInteger> getConflictingDpnsAlreadyConfiguredWithTz(String schemaName, String tzone,
 585                                                                               List<BigInteger> lstDpns, List<VtepConfigSchema> existingSchemas) {
 586         List<BigInteger> lstConflictingDpns = new ArrayList<>();
 587         for (VtepConfigSchema schema : emptyIfNull(existingSchemas)) {
 588             if (!StringUtils.equalsIgnoreCase(schemaName, schema.getSchemaName())
 589                     && StringUtils.equals(schema.getTransportZoneName(), tzone)) {
 590                 lstConflictingDpns = new ArrayList<>(getDpnIdList(schema.getDpnIds()));
 591                 lstConflictingDpns.retainAll(lstDpns);
 592                 if (!lstConflictingDpns.isEmpty()) {
 593                     break;
 594                 }
 595             }
 596         }
 597         return lstConflictingDpns;
 598     }
 599     public static VtepConfigSchema constructVtepConfigSchema(String schemaName, String portName, Integer vlanId,
 600                                                              String subnetMask, String gatewayIp, String transportZone,String tunnelType, List<BigInteger> dpnIds,
 601                                                              String excludeIpFilter) {
 602         IpAddress gatewayIpObj = StringUtils.isBlank(gatewayIp) ? null : new IpAddress(gatewayIp.toCharArray());
 603         IpPrefix subnet = StringUtils.isBlank(subnetMask) ? null : new IpPrefix(subnetMask.toCharArray());
 604         Class<? extends TunnelTypeBase> tunType ;
 605         if( tunnelType.equals(ITMConstants.TUNNEL_TYPE_VXLAN)) {
 606             tunType = TunnelTypeVxlan.class ;
 607         } else {
 608             tunType = TunnelTypeGre.class ;
 609         }
 610         VtepConfigSchemaBuilder schemaBuilder = new VtepConfigSchemaBuilder().setSchemaName(schemaName)
 611                 .setPortName(portName).setVlanId(vlanId).setSubnet(subnet).setGatewayIp(gatewayIpObj)
 612                 .setTransportZoneName(transportZone).setTunnelType(tunType).setDpnIds(getDpnIdsListFromBigInt(dpnIds))
 613                 .setExcludeIpFilter(excludeIpFilter);
 614         return schemaBuilder.build();
 615     }
 616     public static List<IpAddress> getExcludeIpAddresses(String excludeIpFilter, SubnetInfo subnetInfo) {
 617         final List<IpAddress> lstIpAddress = new ArrayList<>();
 618         if (StringUtils.isBlank(excludeIpFilter)) {
 619             return lstIpAddress;
 620         }
 621         final String[] arrIps = StringUtils.split(excludeIpFilter, ',');
 622         for (String ip : arrIps) {
 623             if (StringUtils.countMatches(ip, "-") == 1) {
 624                 final String[] arrIpRange = StringUtils.split(ip, '-');
 625                 String strStartIp = StringUtils.trim(arrIpRange[0]);
 626                 String strEndIp = StringUtils.trim(arrIpRange[1]);
 627                 Preconditions.checkArgument(InetAddresses.isInetAddress(strStartIp),
 628                         "Invalid exclude IP filter: invalid IP address value " + strStartIp);
 629                 Preconditions.checkArgument(InetAddresses.isInetAddress(strEndIp),
 630                         "Invalid exclude IP filter: invalid IP address value " + strEndIp);
 631                 Preconditions.checkArgument(subnetInfo.isInRange(strStartIp),
 632                         "Invalid exclude IP filter: IP address [" + strStartIp +
 633                                 "] not in subnet range " + subnetInfo.getCidrSignature());
 634                 Preconditions.checkArgument(subnetInfo.isInRange(strEndIp),
 635                         "Invalid exclude IP filter: IP address [" + strEndIp +
 636                                 "] not in subnet range " + subnetInfo.getCidrSignature());
 637                 int startIp = subnetInfo.asInteger(strStartIp);
 638                 int endIp = subnetInfo.asInteger(strEndIp);
 639
 640                 Preconditions.checkArgument(startIp < endIp,
 641                         "Invalid exclude IP filter: Invalid range [" + ip + "] ");
 642                 for (int i = startIp; i <= endIp; i++) {
 643                     String ipAddress = ipFormat(toIpArray(i));
 644                     validateAndAddIpAddressToList(subnetInfo, lstIpAddress, ipAddress);
 645                 }
 646             } else {
 647                 validateAndAddIpAddressToList(subnetInfo, lstIpAddress, ip);
 648             }
 649         }
 650         return lstIpAddress;
 651     }
 652     private static void validateAndAddIpAddressToList(SubnetInfo subnetInfo, final List<IpAddress> lstIpAddress,
 653                                                       String ipAddress) {
 654         String ip = StringUtils.trim(ipAddress);
 655         Preconditions.checkArgument(InetAddresses.isInetAddress(ip),
 656                 "Invalid exclude IP filter: invalid IP address value " + ip);
 657         Preconditions.checkArgument(subnetInfo.isInRange(ip),
 658                 "Invalid exclude IP filter: IP address [" + ip + "] not in subnet range " +
 659                         subnetInfo.getCidrSignature());
 660         lstIpAddress.add(new IpAddress(ip.toCharArray()));
 661     }
 662     private static int[] toIpArray(int val) {
 663         int[] ret = new int[4];
 664         for (int j = 3; j >= 0; --j) {
 665             ret[j] |= val >>> 8 * (3 - j) & 0xff;
 666         }
 667         return ret;
 668     }
 669     private static String ipFormat(int[] octets) {
 670         StringBuilder str = new StringBuilder();
 671         for (int i = 0; i < octets.length; ++i) {
 672             str.append(octets[i]);
 673             if (i != octets.length - 1) {
 674                 str.append(".");
 675             }
 676         }
 677         return str.toString();
 678     }
 679     public static VtepConfigSchema validateForUpdateVtepSchema(String schemaName, List<BigInteger> lstDpnsForAdd,
 680                                                                List<BigInteger> lstDpnsForDelete, IITMProvider itmProvider) {
 681         Preconditions.checkArgument(StringUtils.isNotBlank(schemaName));
 682         if ((lstDpnsForAdd == null || lstDpnsForAdd.isEmpty())
 683                 && (lstDpnsForDelete == null || lstDpnsForDelete.isEmpty())) {
 684             Preconditions.checkArgument(false,
 685                     "DPN ID list for add | delete is null or empty in schema " + schemaName);
 686         }
 687         VtepConfigSchema schema = itmProvider.getVtepConfigSchema(schemaName);
 688         if (schema == null) {
 689             Preconditions.checkArgument(false, "Specified VTEP Schema [" + schemaName +
 690                     "] doesn't exists!");
 691         }
 692         List<BigInteger> existingDpnIds = getDpnIdList(schema.getDpnIds());
 693         if (isNotEmpty(lstDpnsForAdd)) {
 694             //  if (isNotEmpty(existingDpnIds)) {
 695             List<BigInteger> lstAlreadyExistingDpns = new ArrayList<>(existingDpnIds);
 696             lstAlreadyExistingDpns.retainAll(lstDpnsForAdd);
 697             Preconditions.checkArgument(lstAlreadyExistingDpns.isEmpty(),
 698                     "DPN ID's " + lstAlreadyExistingDpns +
 699                             " already exists in VTEP schema [" + schemaName + "]");
 700             //    }
 701             if (schema.getTunnelType().equals(TunnelTypeGre.class)) {
 702                 validateForSingleGreTep(schema.getSchemaName(), lstDpnsForAdd, itmProvider.getAllVtepConfigSchemas());
 703             }
 704         }
 705         if (isNotEmpty(lstDpnsForDelete)) {
 706             if (existingDpnIds == null || existingDpnIds.isEmpty()) {
 707                 String builder = "DPN ID's " + lstDpnsForDelete +
 708                         " specified for delete from VTEP schema [" + schemaName +
 709                         "] are not configured in the schema.";
 710                 Preconditions.checkArgument(false, builder);
 711             } else if (!existingDpnIds.containsAll(lstDpnsForDelete)) {
 712                 List<BigInteger> lstConflictingDpns = new ArrayList<>(lstDpnsForDelete);
 713                 lstConflictingDpns.removeAll(existingDpnIds);
 714                 String builder = "DPN ID's " + lstConflictingDpns +
 715                         " specified for delete from VTEP schema [" + schemaName +
 716                         "] are not configured in the schema.";
 717                 Preconditions.checkArgument(false, builder);
 718             }
 719         }
 720         return schema;
 721     }
 722     public static String getSubnetCidrAsString(IpPrefix subnet) {
 723         return subnet == null ? StringUtils.EMPTY : String.valueOf(subnet.getValue());
 724     }
 725     public static <T> List<T> emptyIfNull(List<T> list) {
 726         return list == null ? Collections.emptyList() : list;
 727     }
 728     public static <T> boolean isEmpty(Collection<T> collection) {
 729         return collection == null || collection.isEmpty();
 730     }
 731     public static <T> boolean isNotEmpty(Collection<T> collection) {
 732         return !isEmpty(collection);
 733     }
 734     public static HwVtep createHwVtepObject(String topo_id, String node_id, IpAddress ipAddress, IpPrefix ipPrefix, IpAddress gatewayIP, int vlanID, Class<? extends TunnelTypeBase> tunnel_type, TransportZone transportZone) {
 735         HwVtep hwVtep = new HwVtep();
 736         hwVtep.setGatewayIP(gatewayIP);
 737         hwVtep.setHwIp(ipAddress);
 738         hwVtep.setIpPrefix(ipPrefix);
 739         hwVtep.setNode_id(node_id);
 740         hwVtep.setTopo_id(topo_id);
 741         hwVtep.setTransportZone(transportZone.getZoneName());
 742         hwVtep.setTunnel_type(tunnel_type);
 743         hwVtep.setVlanID(vlanID);
 744         return hwVtep;
 745     }
 746
 747     public static String getHwParentIf(String topo_id, String srcNodeid) {
 748         return String.format("%s:%s", topo_id, srcNodeid);
 749     }
 750
 751     public static <T extends DataObject> void syncWrite(LogicalDatastoreType datastoreType,
 752                                                         InstanceIdentifier<T> path, T data, DataBroker broker) {
 753         WriteTransaction tx = broker.newWriteOnlyTransaction();
 754         tx.put(datastoreType, path, data, true);
 755         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 756         try {
 757             futures.get();
 758         } catch (InterruptedException | ExecutionException e) {
 759             LOG.error("ITMUtils:SyncWrite , Error writing to datastore (path, data) : ({}, {})", path, data);
 760             throw new RuntimeException(e.getMessage());
 761         }
 762     }
 763
 764     public static List<BigInteger> getDpnIdList( List<DpnIds> dpnIds ) {
 765         List<BigInteger> dpnList = new ArrayList<>() ;
 766         for( DpnIds dpn : dpnIds) {
 767             dpnList.add(dpn.getDPN()) ;
 768         }
 769         return dpnList ;
 770     }
 771
 772     public static List<DpnIds> getDpnIdsListFromBigInt( List<BigInteger> dpnIds) {
 773         List<DpnIds> dpnIdList = new ArrayList<>() ;
 774         DpnIdsBuilder builder = new DpnIdsBuilder() ;
 775         for( BigInteger dpnId : dpnIds) {
 776             dpnIdList.add(builder.setKey(new DpnIdsKey(dpnId)).setDPN(dpnId).build() );
 777         }
 778         return dpnIdList;
 779     }
 780
 781     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(String interfaceName) {
 782         InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> idBuilder =
 783                 InstanceIdentifier.builder(InterfacesState.class)
 784                         .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class,
 785                                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey(
 786                                         interfaceName));
 787         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> id = idBuilder.build();
 788         return id;
 789     }
 790     public static Boolean readMonitoringStateFromCache(DataBroker dataBroker) {
 791         InstanceIdentifier<TunnelMonitorParams> iid = InstanceIdentifier.create(TunnelMonitorParams.class);
 792         TunnelMonitorParams tunnelMonitorParams = (TunnelMonitorParams) DataStoreCache.get(ITMConstants.ITM_MONIRORING_PARAMS_CACHE_NAME,iid,"MonitorParams",dataBroker,true);
 793         if(tunnelMonitorParams!=null) {
 794             return tunnelMonitorParams.isEnabled();
 795         } else {
 796             return ITMConstants.DEFAULT_MONITOR_ENABLED;
 797         }
 798     }
 799
 800     public static Integer readMonitorIntervalfromCache(DataBroker dataBroker) {
 801         InstanceIdentifier<TunnelMonitorInterval> iid = InstanceIdentifier.create(TunnelMonitorInterval.class);
 802         TunnelMonitorInterval tunnelMonitorIOptional = (TunnelMonitorInterval)DataStoreCache.get(ITMConstants.ITM_MONIRORING_PARAMS_CACHE_NAME,iid,"Interval",dataBroker,true);
 803         if(tunnelMonitorIOptional!=null) {
 804             return tunnelMonitorIOptional.getInterval();
 805         }
 806         return null;
 807
 808     }
 809
 810     public static Integer determineMonitorInterval(DataBroker dataBroker) {
 811         Integer monitorInterval = ItmUtils.readMonitorIntervalfromCache(dataBroker);
 812         LOG.debug("determineMonitorInterval: monitorInterval from DS = {}", monitorInterval);
 813         if(monitorInterval==null){
 814             Class<? extends TunnelMonitoringTypeBase> monitorProtocol = determineMonitorProtocol(dataBroker);
 815             if(monitorProtocol.isAssignableFrom(TunnelMonitoringTypeBfd.class)) {
 816                 monitorInterval = ITMConstants.BFD_DEFAULT_MONITOR_INTERVAL;
 817             } else {
 818                 monitorInterval = ITMConstants.DEFAULT_MONITOR_INTERVAL;
 819             }
 820         }
 821         LOG.debug("determineMonitorInterval: monitorInterval = {}", monitorInterval);
 822         InstanceIdentifier<TunnelMonitorInterval> iid = InstanceIdentifier.builder(TunnelMonitorInterval.class).build();
 823         TunnelMonitorInterval intervalBuilder = new TunnelMonitorIntervalBuilder().setInterval(monitorInterval).build();
 824         ItmUtils.asyncUpdate(LogicalDatastoreType.OPERATIONAL,iid, intervalBuilder, dataBroker, ItmUtils.DEFAULT_CALLBACK);
 825         return monitorInterval;
 826     }
 827
 828     public static List<String> getInternalTunnelInterfaces(DataBroker dataBroker){
 829         List<String> tunnelList = new ArrayList<>();
 830         Collection<String> internalInterfaces = itmCache.getAllInternalInterfaces();
 831         if(internalInterfaces == null) {
 832             updateTunnelsCache(dataBroker);
 833             internalInterfaces = itmCache.getAllInternalInterfaces();
 834         }
 835         LOG.debug("ItmUtils.getTunnelList Cache Internal Interfaces size: {} ", internalInterfaces.size());
 836         if(internalInterfaces!=null) {
 837             tunnelList.addAll(internalInterfaces);
 838         }
 839         LOG.trace("ItmUtils.getTunnelList Internal: {}", tunnelList);
 840         return tunnelList;
 841     }
 842
 843     public static List<String> getTunnelsofTzone(List<HwVtep> hwVteps, String tzone, DataBroker dataBroker, Boolean hwVtepsExist) {
 844
 845         List<String> tunnels = new ArrayList<>();
 846         InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class).
 847                 child(TransportZone.class, new TransportZoneKey(tzone)).build();
 848         Optional<TransportZone> tZoneOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, path, dataBroker);
 849         if (tZoneOptional.isPresent()) {
 850             TransportZone transportZone = tZoneOptional.get();
 851             Class<? extends TunnelTypeBase> tunType = transportZone.getTunnelType();
 852             if (transportZone.getSubnets() != null && !transportZone.getSubnets().isEmpty()) {
 853                 for (Subnets sub : transportZone.getSubnets()) {
 854                     if (sub.getVteps() != null && !sub.getVteps().isEmpty()) {
 855                         for (Vteps vtepLocal : sub.getVteps()) {
 856                             for (Vteps vtepRemote : sub.getVteps()) {
 857                                 if (!vtepLocal.equals(vtepRemote)) {
 858                                     InternalTunnelKey key = new InternalTunnelKey(vtepRemote.getDpnId(), vtepLocal.getDpnId(), tunType);
 859                                     InstanceIdentifier<InternalTunnel> intIID =
 860                                             InstanceIdentifier.builder(TunnelList.class).
 861                                                     child(InternalTunnel.class, key).build();
 862                                     Optional<InternalTunnel> TunnelsOptional =
 863                                             ItmUtils.read(LogicalDatastoreType.CONFIGURATION, intIID, dataBroker);
 864                                     if (TunnelsOptional.isPresent()) {
 865                                         String tunnelInterfaceName = TunnelsOptional.get().getTunnelInterfaceName();
 866                                         LOG.trace("Internal Tunnel added {}", tunnelInterfaceName);
 867                                         tunnels.add(tunnelInterfaceName);
 868                                     }
 869                                 }
 870                             }
 871                             if(hwVteps!= null && !hwVteps.isEmpty()) {
 872                                 for (HwVtep hwVtep : hwVteps) {
 873                                     tunnels.add(getExtTunnel(hwVtep.getNode_id(), vtepLocal.getDpnId().toString(),
 874                                             tunType, dataBroker));
 875                                     tunnels.add(getExtTunnel(vtepLocal.getDpnId().toString(), hwVtep.getNode_id(),
 876                                             tunType, dataBroker));
 877                                 }
 878                             }
 879                         }
 880                     }
 881                 }
 882             }
 883             if (hwVtepsExist) {
 884                 for (HwVtep hwVtep : hwVteps) {
 885                     for (HwVtep hwVtepOther : hwVteps) {
 886                         if (!hwVtep.getHwIp().equals(hwVtepOther.getHwIp())) {
 887                             tunnels.add(getExtTunnel(hwVtep.getNode_id(), hwVtepOther.getNode_id(), tunType, dataBroker));
 888                             tunnels.add(getExtTunnel(hwVtepOther.getNode_id(), hwVtep.getNode_id(), tunType, dataBroker));
 889                         }
 890                     }
 891                 }
 892             }
 893         }
 894         return tunnels;
 895     }
 896
 897     public static List<String> getInternalTunnelsofTzone(String tzone, DataBroker dataBroker) {
 898         List<String> tunnels = new ArrayList<>();
 899         LOG.trace("Getting internal tunnels of {}",tzone);
 900         InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class).
 901                 child(TransportZone.class, new TransportZoneKey(tzone)).build();
 902         Optional<TransportZone> tZoneOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, path, dataBroker);
 903         if (tZoneOptional.isPresent()) {
 904             TransportZone transportZone = tZoneOptional.get();
 905             if (transportZone.getSubnets() != null && !transportZone.getSubnets().isEmpty()) {
 906                 for (Subnets sub : transportZone.getSubnets()) {
 907                     if (sub.getVteps() != null && !sub.getVteps().isEmpty()) {
 908                         for (Vteps vtepLocal : sub.getVteps()) {
 909                             for (Vteps vtepRemote : sub.getVteps()) {
 910                                 if (!vtepLocal.equals(vtepRemote)) {
 911                                     InternalTunnelKey key =
 912                                             new InternalTunnelKey(vtepRemote.getDpnId(), vtepLocal.getDpnId(),
 913                                                     transportZone.getTunnelType());
 914                                     InstanceIdentifier<InternalTunnel> intIID =
 915                                             InstanceIdentifier.builder(TunnelList.class).
 916                                                     child(InternalTunnel.class, key).build();
 917                                     Optional<InternalTunnel> tunnelsOptional =
 918                                             ItmUtils.read(LogicalDatastoreType.CONFIGURATION, intIID, dataBroker);
 919                                     if (tunnelsOptional.isPresent()) {
 920                                         String tunnelInterfaceName = tunnelsOptional.get().getTunnelInterfaceName();
 921                                         LOG.trace("Internal Tunnel added {}", tunnelInterfaceName);
 922                                         tunnels.add(tunnelInterfaceName);
 923                                     }
 924                                 }
 925                             }
 926                         }
 927                     }
 928                 }
 929             }
 930         }
 931         return tunnels;
 932     }
 933
 934     private static String getExtTunnel(String node_id, String dpId,Class<? extends TunnelTypeBase> tunType, DataBroker dataBroker) {
 935         LOG.trace("getting ext tunnel for {} and dpId {}",node_id,dpId);
 936         ExternalTunnelKey key = getExternalTunnelKey(dpId, node_id, tunType);
 937         InstanceIdentifier<ExternalTunnel> intIID = InstanceIdentifier.builder(ExternalTunnelList.class).
 938                 child(ExternalTunnel.class, key).build();
 939         Optional<ExternalTunnel> tunnelsOptional =
 940                 ItmUtils.read(LogicalDatastoreType.CONFIGURATION, intIID, dataBroker);
 941         if (tunnelsOptional.isPresent()) {
 942             String tunnelInterfaceName = tunnelsOptional.get().getTunnelInterfaceName();
 943             LOG.trace("ext tunnel returned {} ", tunnelInterfaceName);
 944             return tunnelInterfaceName;
 945         }
 946         return null;
 947     }
 948     public static ExternalTunnelKey getExternalTunnelKey(String dst , String src, Class<? extends TunnelTypeBase> tunType) {
 949         if (src.indexOf("physicalswitch") > 0) {
 950             src = src.substring(0, src.indexOf("physicalswitch") - 1);
 951         }
 952         if (dst.indexOf("physicalswitch") > 0) {
 953             dst = dst.substring(0, dst.indexOf("physicalswitch") - 1);
 954         }
 955         return new ExternalTunnelKey(dst, src, tunType);
 956     }
 957
 958     public static List<TunnelEndPoints> getTEPsForDpn( BigInteger srcDpn, List<DPNTEPsInfo> dpnList) {
 959         for (DPNTEPsInfo dpn : dpnList) {
 960             if( dpn.getDPNID().equals(srcDpn)) {
 961                 return dpn.getTunnelEndPoints() ;
 962             }
 963         }
 964         return null ;
 965     }
 966     public static TunnelList getAllInternalTunnels(DataBroker broker) {
 967         InstanceIdentifier<TunnelList> tunnelListInstanceIdentifier = InstanceIdentifier.builder(TunnelList.class).build();
 968         return read(LogicalDatastoreType.CONFIGURATION, tunnelListInstanceIdentifier, broker).orNull();
 969     }
 970     public static InternalTunnel getInternalTunnel(String interfaceName, DataBroker broker) {
 971         InternalTunnel internalTunnel = null;
 972         TunnelList tunnelList = getAllInternalTunnels(broker);
 973         if (tunnelList != null && tunnelList.getInternalTunnel() != null) {
 974             List<InternalTunnel> internalTunnels = tunnelList.getInternalTunnel();
 975             for (InternalTunnel tunnel : internalTunnels) {
 976                 if (tunnel.getTunnelInterfaceName().equalsIgnoreCase(interfaceName)) {
 977                     internalTunnel = tunnel;
 978                     break;
 979                 }
 980             }
 981         }
 982         return internalTunnel;
 983     }
 984     public static ExternalTunnel getExternalTunnel(String interfaceName, DataBroker broker) {
 985         ExternalTunnel externalTunnel = null;
 986         List<ExternalTunnel> externalTunnels = getAllExternalTunnels(broker);
 987         for (ExternalTunnel tunnel : externalTunnels) {
 988             if (StringUtils.equalsIgnoreCase(interfaceName, tunnel.getTunnelInterfaceName())) {
 989                 externalTunnel = tunnel;
 990                 break;
 991             }
 992         }
 993         return externalTunnel;
 994     }
 995     public static List<ExternalTunnel> getAllExternalTunnels(DataBroker broker) {
 996         List<ExternalTunnel> result = null;
 997         InstanceIdentifier<ExternalTunnelList> id = InstanceIdentifier.builder(ExternalTunnelList.class).build();
 998         Optional<ExternalTunnelList> tunnelList = read(LogicalDatastoreType.CONFIGURATION, id, broker);
 999         if (tunnelList.isPresent()) {
1000             result = tunnelList.get().getExternalTunnel();
1001         }
1002         if (result == null) {
1003             result = Collections.emptyList();
1004         }
1005         return result;
1006     }
1007     public static String convertTunnelTypetoString(Class<? extends TunnelTypeBase> tunType ) {
1008         String tunnelType = ITMConstants.TUNNEL_TYPE_VXLAN;
1009         if( tunType.equals(TunnelTypeVxlan.class)) {
1010             tunnelType = ITMConstants.TUNNEL_TYPE_VXLAN ;
1011         } else if( tunType.equals(TunnelTypeGre.class) ) {
1012             tunnelType = ITMConstants.TUNNEL_TYPE_GRE ;
1013         } else if (tunnelType.equals(TunnelTypeMplsOverGre.class)) {
1014             tunnelType = ITMConstants.TUNNEL_TYPE_MPLSoGRE;
1015         }
1016         return tunnelType ;
1017     }
1018
1019
1020     public static boolean isItmIfType(Class<? extends InterfaceType> ifType) {
1021         return ifType != null && ifType.isAssignableFrom(Tunnel.class);
1022     }
1023
1024     public static StateTunnelListKey getTunnelStateKey( org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface iface) {
1025         StateTunnelListKey key = null;
1026         if(isItmIfType(iface.getType())) {
1027             key = new StateTunnelListKey(iface.getName());
1028         }
1029         return key;
1030     }
1031
1032     public static void updateTunnelsCache(DataBroker broker) {
1033         List<InternalTunnel> internalTunnels = getAllInternalTunnels(broker, LogicalDatastoreType.CONFIGURATION);
1034         for (InternalTunnel tunnel : internalTunnels) {
1035             itmCache.addInternalTunnel(tunnel);
1036         }
1037         List<ExternalTunnel> externalTunnels = getAllExternalTunnels(broker, LogicalDatastoreType.CONFIGURATION);
1038         for (ExternalTunnel tunnel : externalTunnels) {
1039             itmCache.addExternalTunnel(tunnel);
1040         }
1041     }
1042
1043     public static List<ExternalTunnel> getAllExternalTunnels(DataBroker dataBroker, LogicalDatastoreType datastoreType) {
1044         List<ExternalTunnel> result = null;
1045         InstanceIdentifier<ExternalTunnelList> iid = InstanceIdentifier.builder(ExternalTunnelList.class).build();
1046         Optional<ExternalTunnelList> tunnelList = read(LogicalDatastoreType.CONFIGURATION, iid, dataBroker);
1047         if (tunnelList.isPresent()) {
1048             result = tunnelList.get().getExternalTunnel();
1049         }
1050         if (result == null) {
1051             result = Collections.emptyList();
1052         }
1053         return result;
1054     }
1055
1056     public static List<InternalTunnel> getAllInternalTunnels(DataBroker dataBroker, LogicalDatastoreType datastoreType) {
1057         List<InternalTunnel> result = null;
1058         InstanceIdentifier<TunnelList> iid = InstanceIdentifier.builder(TunnelList.class).build();
1059         Optional<TunnelList> tunnelList = read(LogicalDatastoreType.CONFIGURATION, iid, dataBroker);
1060         if (tunnelList.isPresent()) {
1061             result = tunnelList.get().getInternalTunnel();
1062         }
1063         if (result == null) {
1064             result = Collections.emptyList();
1065         }
1066         return result;
1067     }
1068
1069     public static Interface getInterface(
1070             String name, DataBroker broker) {
1071         Interface result = itmCache.getInterface(name);
1072         if (result == null) {
1073             InstanceIdentifier<Interface> iid =
1074                     InstanceIdentifier.builder(Interfaces.class)
1075                             .child(Interface.class, new InterfaceKey(name)).build();
1076             Optional<Interface> optInterface = read(LogicalDatastoreType.CONFIGURATION, iid, broker);
1077             if (optInterface.isPresent()) {
1078                 result = optInterface.get();
1079                 itmCache.addInterface(result);
1080             }
1081         }
1082         return result;
1083     }
1084
1085     public static Class<? extends TunnelMonitoringTypeBase> readMonitoringProtocolFromCache(DataBroker dataBroker) {
1086         InstanceIdentifier<TunnelMonitorParams> iid = InstanceIdentifier.create(TunnelMonitorParams.class);
1087         TunnelMonitorParams tunnelMonitorParams = (TunnelMonitorParams) DataStoreCache.get(ITMConstants.ITM_MONIRORING_PARAMS_CACHE_NAME,iid,"MonitorParams",dataBroker,true);
1088         if(tunnelMonitorParams!=null) {
1089             return tunnelMonitorParams.getMonitorProtocol();
1090         }
1091         return null;
1092     }
1093
1094     public static Class<? extends TunnelMonitoringTypeBase> determineMonitorProtocol(DataBroker dataBroker) {
1095         Class<? extends TunnelMonitoringTypeBase> monitoringProtocol = ItmUtils.readMonitoringProtocolFromCache(dataBroker);
1096         LOG.debug("determineMonitorProtocol: monitorProtocol from DS = {}", monitoringProtocol);
1097         if(monitoringProtocol==null) {
1098             monitoringProtocol = ITMConstants.DEFAULT_MONITOR_PROTOCOL;
1099         }
1100         LOG.debug("determineMonitorProtocol: monitorProtocol = {}", monitoringProtocol);
1101         Boolean monitorState = ItmUtils.readMonitoringStateFromCache(dataBroker);
1102         if(monitorState==null) {
1103             monitorState = true;
1104         }
1105         LOG.debug("determineMonitorProtocol: monitorState = {}", monitorState);
1106         InstanceIdentifier<TunnelMonitorParams> iid = InstanceIdentifier.builder(TunnelMonitorParams.class).build();
1107         TunnelMonitorParams protocolBuilder = new TunnelMonitorParamsBuilder().setEnabled(monitorState).setMonitorProtocol(monitoringProtocol).build();
1108         ItmUtils.asyncUpdate(LogicalDatastoreType.OPERATIONAL,iid, protocolBuilder, dataBroker, ItmUtils.DEFAULT_CALLBACK);
1109         return monitoringProtocol;
1110     }
1111
1112     public static List<DcGatewayIp> getDcGatewayIpList(DataBroker broker){
1113         InstanceIdentifier<DcGatewayIpList> dcGatewayIpListid = InstanceIdentifier.builder(DcGatewayIpList.class).build();
1114         Optional<DcGatewayIpList> dcGatewayIpListConfig = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, dcGatewayIpListid, broker);
1115         if(dcGatewayIpListConfig.isPresent()){
1116             DcGatewayIpList containerList = dcGatewayIpListConfig.get();
1117             if(containerList != null){
1118                 return containerList.getDcGatewayIp();
1119             }
1120         }
1121         return null;
1122     }
1123
1124     public static boolean falseIfNull(Boolean value) {
1125         return value == null ? false : value;
1126     }
1127
1128     public static <T> List<T> getIntersection(List<T> list1, List<T> list2) {
1129         List<T> list = new ArrayList<>();
1130         for (T t : list1) {
1131             if(list2.contains(t)) {
1132                 list.add(t);
1133             }
1134         }
1135         LOG.debug( " getIntersection - L1 {}, L2 - {}, Intersection - {}", list1, list2, list);
1136         return list;
1137     }
1138
1139     public static void addTransportZoneMembership(List<TzMembership> zones, String zoneName) {
1140         zones.add(new TzMembershipBuilder().setZoneName(zoneName).build());
1141     }
1142
1143     public static  List<TzMembership> createTransportZoneMembership(String zoneName) {
1144         List<TzMembership> zones = new ArrayList<>();
1145         zones.add(new TzMembershipBuilder().setZoneName(zoneName).build());
1146         return zones;
1147     }
1148
1149     /**
1150      * Returns the transport zone from Configuration datastore.
1151      *
1152      * @param tzName transport zone name
1153      * @param dataBroker data broker handle to perform operations on datastore
1154      */
1155     // FIXME: Better is to implement cache to avoid datastore read.
1156     public static TransportZone getTransportZoneFromConfigDS(String tzName, DataBroker dataBroker) {
1157         InstanceIdentifier<TransportZone> tzonePath = InstanceIdentifier.builder(TransportZones.class)
1158             .child(TransportZone.class, new TransportZoneKey(tzName)).build();
1159         Optional<TransportZone> tZoneOptional = ItmUtils.read(LogicalDatastoreType.CONFIGURATION, tzonePath,
1160             dataBroker);
1161         if (tZoneOptional.isPresent()) {
1162             return tZoneOptional.get();
1163         }
1164         return null;
1165     }
1166
1167     /**
1168      * Gets the transport zone in TepsNotHosted list in the Configuration Datastore
1169      * based on transport zone name
1170      *
1171      * @param unknownTz transport zone name
1172      *
1173      * @param dataBroker data broker handle to perform read operations on config datastore
1174      *
1175      * @return the TepsNotHostedInTransportZone object in the TepsNotHosted list in Config DS
1176      */
1177     public static TepsNotHostedInTransportZone getUnknownTransportZoneFromITMConfigDS(
1178         String unknownTz, DataBroker dataBroker) {
1179         InstanceIdentifier<TepsNotHostedInTransportZone> unknownTzPath =
1180             InstanceIdentifier.builder(TransportZones.class)
1181                 .child(TepsNotHostedInTransportZone.class,
1182                     new TepsNotHostedInTransportZoneKey(unknownTz)).build();
1183         Optional<TepsNotHostedInTransportZone> unknownTzOptional =
1184             ItmUtils.read(LogicalDatastoreType.CONFIGURATION, unknownTzPath, dataBroker);
1185         if (unknownTzOptional.isPresent()) {
1186             return unknownTzOptional.get();
1187         }
1188         return null;
1189     }
1190
1191     /**
1192      * Gets the bridge datapath ID from Network topology Node's OvsdbBridgeAugmentation
1193      * in the Operational DS.
1194      *
1195      * @param node Network Topology Node
1196      *
1197      * @param bridge bridge name
1198      *
1199      * @param dataBroker data broker handle to perform operations on datastore
1200      *
1201      * @return the datapath ID of bridge in string form
1202      */
1203     public static String getBridgeDpid(Node node, String bridge, DataBroker dataBroker) {
1204         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = null;
1205         Node bridgeNode = null;
1206         String datapathId = null;
1207
1208         NodeId ovsdbNodeId = node.getKey().getNodeId();
1209
1210         NodeId brNodeId = new NodeId(ovsdbNodeId.getValue()
1211             + "/" + ITMConstants.BRIDGE_URI_PREFIX + "/" + bridge);
1212
1213         InstanceIdentifier<Node> bridgeIid =
1214             InstanceIdentifier
1215                 .create(NetworkTopology.class)
1216                 .child(Topology.class, new TopologyKey(IfmConstants.OVSDB_TOPOLOGY_ID))
1217                 .child(Node.class,new NodeKey(brNodeId));
1218
1219         Optional<Node> opBridgeNode = ItmUtils.read(LogicalDatastoreType.OPERATIONAL, bridgeIid, dataBroker);
1220
1221         if (opBridgeNode.isPresent()) {
1222             bridgeNode = opBridgeNode.get();
1223         }
1224         if (bridgeNode != null) {
1225             ovsdbBridgeAugmentation = bridgeNode.getAugmentation(OvsdbBridgeAugmentation.class);
1226         }
1227
1228         if (ovsdbBridgeAugmentation != null && ovsdbBridgeAugmentation.getDatapathId() != null) {
1229             datapathId = ovsdbBridgeAugmentation.getDatapathId().getValue();
1230         }
1231         return datapathId;
1232     }
1233
1234     /**
1235      * Gets the Network topology Node from Operational Datastore
1236      * based on Bridge Augmentation.
1237      *
1238      * @param bridgeAugmentation bridge augmentation of OVSDB node
1239      *
1240      * @param dataBroker data broker handle to perform operations on datastore
1241      *
1242      * @return the Network Topology Node i.e. OVSDB node which is managing the specified bridge
1243      */
1244     public static Node getOvsdbNode(OvsdbBridgeAugmentation bridgeAugmentation,
1245         DataBroker dataBroker) {
1246         Node ovsdbNode = null;
1247         Optional<Node> opOvsdbNode = null;
1248         if (bridgeAugmentation != null) {
1249             InstanceIdentifier<Node> ovsdbNodeIid =
1250                 (InstanceIdentifier<Node>) bridgeAugmentation.getManagedBy().getValue();
1251             opOvsdbNode = ItmUtils.read(LogicalDatastoreType.OPERATIONAL, ovsdbNodeIid, dataBroker);
1252         }
1253         if (opOvsdbNode.isPresent()) {
1254             ovsdbNode = opOvsdbNode.get();
1255         }
1256         return ovsdbNode;
1257     }
1258
1259     /**
1260      * Gets the bridge datapath ID in string form from
1261      * Network topology Node's OvsdbBridgeAugmentation in the Operational DS.
1262      *
1263      * @param node Network Topology Node
1264      *
1265      * @return the datapath ID of bridge in string form
1266      */
1267     public static String getStrDatapathId(Node node) {
1268         OvsdbBridgeAugmentation ovsdbBridgeAugmentation =
1269             node.getAugmentation(OvsdbBridgeAugmentation.class);
1270         String datapathId = null;
1271         if (ovsdbBridgeAugmentation != null && ovsdbBridgeAugmentation.getDatapathId() != null) {
1272             datapathId = ovsdbBridgeAugmentation.getDatapathId().getValue();
1273         }
1274         return datapathId;
1275     }
1276
1277     /**
1278      * Returns the dummy subnet (255.255.255.255/32) as IpPrefix object
1279      *
1280      * @return the dummy subnet (255.255.255.255/32) in IpPrefix object
1281      */
1282     public static IpPrefix getDummySubnet() {
1283         return DUMMY_IP_PREFIX;
1284     }
1285
1286     /**
1287      * Deletes the transport zone from Configuration datastore.
1288      *
1289      * @param tzName transport zone name
1290      * @param dataBroker data broker handle to perform operations on datastore
1291      */
1292     public static void deleteTransportZoneFromConfigDS(String tzName, DataBroker dataBroker) {
1293         // check whether transport-zone exists in config DS.
1294         TransportZone tZoneFromConfigDS = ItmUtils.getTransportZoneFromConfigDS(tzName, dataBroker);
1295         if (tZoneFromConfigDS != null) {
1296             // it exists, delete default-TZ now
1297             InstanceIdentifier<TransportZone> path = InstanceIdentifier.builder(TransportZones.class)
1298                 .child(TransportZone.class,
1299                     new TransportZoneKey(tzName)).build();
1300             LOG.debug("Removing {} transport-zone from config DS.", tzName);
1301             ItmUtils.asyncDelete(LogicalDatastoreType.CONFIGURATION, path, dataBroker, ItmUtils.DEFAULT_CALLBACK);
1302         }
1303     }
1304
1305     /**
1306      * Validates the tunnelType argument and returnsTunnelTypeBase class object
1307      * corresponding to tunnelType obtained in String format.
1308      *
1309      * @param tunnelType type of tunnel in string form
1310      *
1311      * @return tunnel-type in TunnelTypeBase object
1312      */
1313     public static Class<? extends TunnelTypeBase> getTunnelType(String tunnelType) {
1314         // validate tunnelType string, in case it is NULL or empty, then
1315         // take VXLAN tunnel type by default
1316         if (tunnelType == null || tunnelType.isEmpty()) {
1317             return TUNNEL_TYPE_MAP.get(ITMConstants.TUNNEL_TYPE_VXLAN);
1318         } else if (!tunnelType.equals(ITMConstants.TUNNEL_TYPE_VXLAN) &&
1319             !tunnelType.equals(ITMConstants.TUNNEL_TYPE_GRE)) {
1320             // if tunnel type is some incorrect value, then
1321             // take VXLAN tunnel type by default
1322             return TUNNEL_TYPE_MAP.get(ITMConstants.TUNNEL_TYPE_VXLAN);
1323         }
1324
1325         // return TunnelTypeBase object corresponding to tunnel-type
1326         return TUNNEL_TYPE_MAP.get(tunnelType);
1327     }
1328
1329     public static List<TzMembership> removeTransportZoneMembership(TunnelEndPoints endPts, List<TzMembership> zones){
1330         LOG.trace( " RemoveTransportZoneMembership TEPs {}, Membership to be removed {} ", endPts, zones);
1331         List<TzMembership> existingTzList = new ArrayList<>(endPts.getTzMembership()) ;
1332         for( TzMembership membership : zones) {
1333             existingTzList.remove(new TzMembershipBuilder().setZoneName(membership.getZoneName()).build());
1334         }
1335         LOG.debug( "Modified Membership List {}", existingTzList);
1336         return existingTzList;
1337     }
1338
1339     public static List<TzMembership> getOriginalTzMembership(TunnelEndPoints srcTep, BigInteger dpnId, List<DPNTEPsInfo> meshedDpnList) {
1340         LOG.trace( "Original Membership for source DPN {}, source TEP {}", dpnId, srcTep) ;
1341         for (DPNTEPsInfo dstDpn : meshedDpnList) {
1342             if( dpnId.equals(dstDpn.getDPNID()) ){
1343                 List<TunnelEndPoints> endPts = dstDpn.getTunnelEndPoints();
1344                 for( TunnelEndPoints tep : endPts) {
1345                     if( tep.getIpAddress().equals( srcTep.getIpAddress())){
1346                         LOG.debug( "Original Membership size " + tep.getTzMembership().size()) ;
1347                         return tep.getTzMembership() ;
1348                     }
1349                 }
1350             }
1351         }
1352         return null ;
1353     }
1354 }