openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/MdsalUtils.java

   1 /*
   2  * Copyright (c) 2015 Red Hat, Inc. 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.ovsdb.openstack.netvirt;
   9
  10 import java.math.BigInteger;
  11 import java.security.InvalidParameterException;
  12 import java.util.ArrayList;
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Map;
  16
  17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  18 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  19 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  22 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  23 import org.opendaylight.ovsdb.openstack.netvirt.api.OvsdbTables;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeInternal;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentationBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeName;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeRef;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentationBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIds;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigs;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntry;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntry;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfo;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntry;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchExternalIds;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchOtherConfigs;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIds;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsKey;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortExternalIds;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortOtherConfigs;
  51 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  54 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
  59 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  60 import org.slf4j.Logger;
  61 import org.slf4j.LoggerFactory;
  62
  63 import com.google.common.base.Optional;
  64 import com.google.common.collect.ImmutableBiMap;
  65 import com.google.common.util.concurrent.CheckedFuture;
  66
  67 /**
  68  * Utility class to wrap mdsal transactions.
  69  *
  70  * @author Sam Hague (shague@redhat.com)
  71  */
  72 public class MdsalUtils {
  73     private static final Logger LOG = LoggerFactory.getLogger(MdsalUtils.class);
  74     private static DataBroker databroker = null;
  75     private static final int OVSDB_UPDATE_TIMEOUT = 500;
  76     private static final String PATCH_PORT_TYPE = "patch";
  77
  78     /**
  79      * Class constructor setting the data broker.
  80      *
  81      * @param dataBroker the {@link org.opendaylight.controller.md.sal.binding.api.DataBroker}
  82      */
  83     public MdsalUtils(DataBroker dataBroker) {
  84         this.databroker = dataBroker;
  85     }
  86
  87     /**
  88      * Executes delete as a blocking transaction.
  89      *
  90      * @param store {@link LogicalDatastoreType} which should be modified
  91      * @param path {@link InstanceIdentifier} to read from
  92      * @param <D> the data object type
  93      * @return the result of the request
  94      */
  95     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> boolean delete(
  96             final LogicalDatastoreType store, final InstanceIdentifier<D> path)  {
  97         boolean result = false;
  98         final WriteTransaction transaction = databroker.newWriteOnlyTransaction();
  99         transaction.delete(store, path);
 100         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
 101         try {
 102             future.checkedGet();
 103             result = true;
 104         } catch (TransactionCommitFailedException e) {
 105             LOG.warn("Failed to delete {} ", path, e);
 106         }
 107         return result;
 108     }
 109
 110     /**
 111      * Executes merge as a blocking transaction.
 112      *
 113      * @param logicalDatastoreType {@link LogicalDatastoreType} which should be modified
 114      * @param path {@link InstanceIdentifier} for path to read
 115      * @param <D> the data object type
 116      * @return the result of the request
 117      */
 118     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> boolean merge(
 119             final LogicalDatastoreType logicalDatastoreType, final InstanceIdentifier<D> path, D data)  {
 120         boolean result = false;
 121         final WriteTransaction transaction = databroker.newWriteOnlyTransaction();
 122         transaction.merge(logicalDatastoreType, path, data, true);
 123         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
 124         try {
 125             future.checkedGet();
 126             result = true;
 127         } catch (TransactionCommitFailedException e) {
 128             LOG.warn("Failed to merge {} ", path, e);
 129         }
 130         return result;
 131     }
 132
 133     /**
 134      * Executes put as a blocking transaction.
 135      *
 136      * @param logicalDatastoreType {@link LogicalDatastoreType} which should be modified
 137      * @param path {@link InstanceIdentifier} for path to read
 138      * @param <D> the data object type
 139      * @return the result of the request
 140      */
 141     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> boolean put(
 142             final LogicalDatastoreType logicalDatastoreType, final InstanceIdentifier<D> path, D data)  {
 143         boolean result = false;
 144         final WriteTransaction transaction = databroker.newWriteOnlyTransaction();
 145         transaction.put(logicalDatastoreType, path, data, true);
 146         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
 147         try {
 148             future.checkedGet();
 149             result = true;
 150         } catch (TransactionCommitFailedException e) {
 151             LOG.warn("Failed to put {} ", path, e);
 152         }
 153         return result;
 154     }
 155
 156     /**
 157      * Executes read as a blocking transaction.
 158      *
 159      * @param store {@link LogicalDatastoreType} to read
 160      * @param path {@link InstanceIdentifier} for path to read
 161      * @param <D> the data object type
 162      * @return the result as the data object requested
 163      */
 164     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> D read(
 165             final LogicalDatastoreType store, final InstanceIdentifier<D> path)  {
 166         D result = null;
 167         final ReadOnlyTransaction transaction = databroker.newReadOnlyTransaction();
 168         Optional<D> optionalDataObject;
 169         CheckedFuture<Optional<D>, ReadFailedException> future = transaction.read(store, path);
 170         try {
 171             optionalDataObject = future.checkedGet();
 172             if (optionalDataObject.isPresent()) {
 173                 result = optionalDataObject.get();
 174             } else {
 175                 LOG.debug("{}: Failed to read {}",
 176                         Thread.currentThread().getStackTrace()[1], path);
 177             }
 178         } catch (ReadFailedException e) {
 179             LOG.warn("Failed to read {} ", path, e);
 180         }
 181         transaction.close();
 182         return result;
 183     }
 184
 185     public static ConnectionInfo getConnectionInfo(Node node) {
 186         ConnectionInfo connectionInfo = null;
 187         OvsdbNodeAugmentation ovsdbNodeAugmentation = node.getAugmentation(OvsdbNodeAugmentation.class);
 188         if (ovsdbNodeAugmentation != null) {
 189             connectionInfo = ovsdbNodeAugmentation.getConnectionInfo();
 190         }
 191         return connectionInfo;
 192     }
 193
 194     public static OvsdbNodeAugmentation getOvsdbNode(Node node) {
 195         return node.getAugmentation(OvsdbNodeAugmentation.class);
 196     }
 197
 198     public static String getOvsdbNodeUUID(Node node) {
 199         String nodeUUID = null;
 200         OvsdbNodeAugmentation ovsdbNodeAugmentation = node.getAugmentation(OvsdbNodeAugmentation.class);
 201         if (ovsdbNodeAugmentation != null) {
 202             // TODO replace with proper uuid and not the system-id
 203             nodeUUID = getOsdbNodeExternalIdsValue(ovsdbNodeAugmentation, "system-id");
 204         }
 205         return nodeUUID;
 206     }
 207
 208     public static String getOsdbNodeExternalIdsValue(OvsdbNodeAugmentation ovsdbNodeAugmentation, String key) {
 209         String value = null;
 210         List<OpenvswitchExternalIds> pairs = ovsdbNodeAugmentation.getOpenvswitchExternalIds();
 211         for (OpenvswitchExternalIds pair : pairs) {
 212             if (pair.getKey().equals(key)) {
 213                 value = pair.getExternalIdValue();
 214             }
 215         }
 216         return value;
 217     }
 218
 219     public static boolean addBridge(Node ovsdbNode, String bridgeName, String target)
 220             throws InterruptedException, InvalidParameterException {
 221         boolean result = false;
 222
 223         LOG.info("Add Bridge: node: {}, bridgeName: {}, target: {}", ovsdbNode, bridgeName, target);
 224         ConnectionInfo connectionInfo = getConnectionInfo(ovsdbNode);
 225         if (connectionInfo != null) {
 226             NodeBuilder bridgeNodeBuilder = new NodeBuilder();
 227             InstanceIdentifier<Node> bridgeIid =
 228                     MdsalHelper.createInstanceIdentifier(connectionInfo, new OvsdbBridgeName(bridgeName));
 229             NodeId bridgeNodeId = MdsalHelper.createManagedNodeId(bridgeIid);
 230             bridgeNodeBuilder.setNodeId(bridgeNodeId);
 231             OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder = new OvsdbBridgeAugmentationBuilder();
 232             ovsdbBridgeAugmentationBuilder.setControllerEntry(createControllerEntries(target));
 233             ovsdbBridgeAugmentationBuilder.setBridgeName(new OvsdbBridgeName(bridgeName));
 234             ovsdbBridgeAugmentationBuilder.setProtocolEntry(createMdsalProtocols());
 235             ovsdbBridgeAugmentationBuilder.setFailMode(
 236                     MdsalHelper.OVSDB_FAIL_MODE_MAP.inverse().get("secure"));
 237             setManagedByForBridge(ovsdbBridgeAugmentationBuilder, connectionInfo);
 238             bridgeNodeBuilder.addAugmentation(OvsdbBridgeAugmentation.class, ovsdbBridgeAugmentationBuilder.build());
 239
 240             result = put(LogicalDatastoreType.CONFIGURATION, bridgeIid, bridgeNodeBuilder.build());
 241             LOG.info("addBridge: result: {}", result);
 242         } else {
 243             throw new InvalidParameterException("Could not find ConnectionInfo");
 244         }
 245         return result;
 246     }
 247
 248     public static boolean deleteBridge(Node ovsdbNode) {
 249         boolean result = false;
 250         InstanceIdentifier<Node> bridgeIid =
 251                 MdsalHelper.createInstanceIdentifier(ovsdbNode.getNodeId());
 252
 253         result = delete(LogicalDatastoreType.CONFIGURATION, bridgeIid);
 254         LOG.info("Delete bridge node: {}, bridgeName: {} result : {}", ovsdbNode, ovsdbNode.getNodeId(),result);
 255         return result;
 256     }
 257
 258     public static OvsdbBridgeAugmentation readBridge(Node node, String name) {
 259         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = null;
 260         ConnectionInfo connectionInfo = getConnectionInfo(node);
 261         if (connectionInfo != null) {
 262             InstanceIdentifier<Node> bridgeIid =
 263                     MdsalHelper.createInstanceIdentifier(connectionInfo, new OvsdbBridgeName(name));
 264             Node bridgeNode = read(LogicalDatastoreType.OPERATIONAL, bridgeIid);
 265             if (bridgeNode != null) {
 266                 ovsdbBridgeAugmentation = bridgeNode.getAugmentation(OvsdbBridgeAugmentation.class);
 267             }
 268         }
 269         return ovsdbBridgeAugmentation;
 270     }
 271
 272     public static Uuid getBridgeUuid(Node node, String name) {
 273         Uuid uuid = null;
 274         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = readBridge(node, name);
 275         if (ovsdbBridgeAugmentation != null) {
 276             uuid = ovsdbBridgeAugmentation.getBridgeUuid();
 277         }
 278         return uuid;
 279     }
 280
 281     private static void setManagedByForBridge(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
 282                                      ConnectionInfo connectionInfo) {
 283         InstanceIdentifier<Node> connectionNodePath = MdsalHelper.createInstanceIdentifier(connectionInfo);
 284         ovsdbBridgeAugmentationBuilder.setManagedBy(new OvsdbNodeRef(connectionNodePath));
 285     }
 286
 287     private static void setControllerForBridge(Node ovsdbNode, String bridgeName, String targetString) {
 288         ConnectionInfo connectionInfo = getConnectionInfo(ovsdbNode);
 289         if (connectionInfo != null) {
 290             for (ControllerEntry controllerEntry: createControllerEntries(targetString)) {
 291                 InstanceIdentifier<ControllerEntry> iid =
 292                         MdsalHelper.createInstanceIdentifier(connectionInfo, new OvsdbBridgeName(bridgeName))
 293                                 .augmentation(OvsdbBridgeAugmentation.class)
 294                                 .child(ControllerEntry.class, controllerEntry.getKey());
 295
 296                 boolean result = put(LogicalDatastoreType.CONFIGURATION, iid, controllerEntry);
 297                 LOG.info("addController: result: {}", result);
 298             }
 299         }
 300     }
 301
 302     private static List<ControllerEntry> createControllerEntries(String targetString) {
 303         List<ControllerEntry> controllerEntries = new ArrayList<ControllerEntry>();
 304         ControllerEntryBuilder controllerEntryBuilder = new ControllerEntryBuilder();
 305         controllerEntryBuilder.setTarget(new Uri(targetString));
 306         controllerEntries.add(controllerEntryBuilder.build());
 307         return controllerEntries;
 308     }
 309
 310     private static List<ProtocolEntry> createMdsalProtocols() {
 311         List<ProtocolEntry> protocolList = new ArrayList<ProtocolEntry>();
 312         ImmutableBiMap<String, Class<? extends OvsdbBridgeProtocolBase>> mapper =
 313                 MdsalHelper.OVSDB_PROTOCOL_MAP.inverse();
 314         protocolList.add(new ProtocolEntryBuilder().
 315                 setProtocol((Class<? extends OvsdbBridgeProtocolBase>) mapper.get("OpenFlow13")).build());
 316         return protocolList;
 317     }
 318
 319     public static long getDataPathId(Node node) {
 320         long dpid = 0L;
 321         String datapathId = getDatapathId(node);
 322         if (datapathId != null) {
 323             dpid = new BigInteger(datapathId.replaceAll(":", ""), 16).longValue();
 324         }
 325         return dpid;
 326     }
 327
 328     public static String getDatapathId(Node node) {
 329         String datapathId = null;
 330         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = node.getAugmentation(OvsdbBridgeAugmentation.class);
 331         if (ovsdbBridgeAugmentation != null && ovsdbBridgeAugmentation.getDatapathId() != null) {
 332             datapathId = node.getAugmentation(OvsdbBridgeAugmentation.class).getDatapathId().getValue();
 333         }
 334         return datapathId;
 335     }
 336
 337     public static String getDatapathId(OvsdbBridgeAugmentation ovsdbBridgeAugmentation) {
 338         String datapathId = null;
 339         if (ovsdbBridgeAugmentation != null && ovsdbBridgeAugmentation.getDatapathId() != null) {
 340             datapathId = ovsdbBridgeAugmentation.getDatapathId().getValue();
 341         }
 342         return datapathId;
 343     }
 344
 345     public static OvsdbBridgeAugmentation getBridge(Node node, String name) {
 346         OvsdbBridgeAugmentation bridge = node.getAugmentation(OvsdbBridgeAugmentation.class);
 347         if (bridge != null) {
 348             if (!bridge.getBridgeName().equals(name)) {
 349                 bridge = null;
 350             }
 351         }
 352         return bridge;
 353     }
 354
 355     public static OvsdbBridgeAugmentation getBridge(Node node) {
 356         OvsdbBridgeAugmentation bridge = node.getAugmentation(OvsdbBridgeAugmentation.class);
 357         return bridge;
 358     }
 359
 360     public static String getBridgeName(Node node) {
 361         String bridgeName = null;
 362         OvsdbBridgeAugmentation bridge = getBridge(node);
 363         if (bridge != null) {
 364             bridgeName = bridge.getBridgeName().getValue();
 365         }
 366         return bridgeName;
 367     }
 368
 369     public static String extractBridgeName(Node node) {
 370         return (node.getAugmentation(OvsdbBridgeAugmentation.class).getBridgeName().getValue());
 371     }
 372
 373     public static OvsdbBridgeAugmentation extractBridgeAugmentation(Node node) {
 374         return node.getAugmentation(OvsdbBridgeAugmentation.class);
 375     }
 376
 377     public static List<Node> getAllBridgesOnOvsdbNode(Node node) {
 378         List<Node> nodes = new ArrayList<Node>();
 379         List<ManagedNodeEntry> managedNodes = node.getAugmentation(OvsdbNodeAugmentation.class).getManagedNodeEntry();
 380         for (ManagedNodeEntry managedNode : managedNodes) {
 381             InstanceIdentifier<?> bridgeIid = managedNode.getBridgeRef().getValue();
 382             Node bridgeNode = (Node) read(LogicalDatastoreType.OPERATIONAL, bridgeIid);
 383             if (bridgeNode != null) {
 384                 nodes.add(bridgeNode);
 385             }
 386         }
 387         return nodes;
 388     }
 389
 390     public static OvsdbNodeAugmentation extractNodeAugmentation(Node node) {
 391         return node.getAugmentation(OvsdbNodeAugmentation.class);
 392     }
 393
 394     /**
 395      * Method read ports from bridge node. Method will check if the provided node
 396      * has the ports details, if not, it will read from Operational data store.
 397      * @param node
 398      * @return
 399      */
 400     public static List<OvsdbTerminationPointAugmentation> getTerminationPointsOfBridge(Node node) {
 401         List<OvsdbTerminationPointAugmentation> tpAugmentations = extractTerminationPointAugmentations(node);
 402         if(tpAugmentations.isEmpty()){
 403             tpAugmentations = readTerminationPointAugmentationFromDataStore(node);
 404         }
 405         return tpAugmentations;
 406     }
 407
 408     public static OvsdbTerminationPointAugmentation extractTerminationPointAugmentation(Node bridgeNode, String portName) {
 409         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = bridgeNode.getAugmentation(OvsdbBridgeAugmentation.class);
 410         if (ovsdbBridgeAugmentation != null) {
 411             List<TerminationPoint> terminationPoints = bridgeNode.getTerminationPoint();
 412             for(TerminationPoint terminationPoint : terminationPoints) {
 413                 OvsdbTerminationPointAugmentation ovsdbTerminationPointAugmentation =
 414                         terminationPoint.getAugmentation( OvsdbTerminationPointAugmentation.class);
 415                 if (ovsdbTerminationPointAugmentation != null
 416                         && ovsdbTerminationPointAugmentation.getName().equals(portName)) {
 417                     return ovsdbTerminationPointAugmentation;
 418                 }
 419             }
 420         }
 421         return null;
 422     }
 423
 424     public static List<TerminationPoint> extractTerminationPoints(Node node) {
 425         List<TerminationPoint> terminationPoints = new ArrayList<TerminationPoint>();
 426         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = node.getAugmentation(OvsdbBridgeAugmentation.class);
 427         if (ovsdbBridgeAugmentation != null) {
 428             terminationPoints.addAll(node.getTerminationPoint());
 429         }
 430         return terminationPoints;
 431     }
 432
 433     public static List<OvsdbTerminationPointAugmentation> extractTerminationPointAugmentations( Node node ) {
 434         List<OvsdbTerminationPointAugmentation> tpAugmentations = new ArrayList<OvsdbTerminationPointAugmentation>();
 435         List<TerminationPoint> terminationPoints = node.getTerminationPoint();
 436         if(terminationPoints != null && !terminationPoints.isEmpty()){
 437             for(TerminationPoint tp : terminationPoints){
 438                 tpAugmentations.add(tp.getAugmentation(OvsdbTerminationPointAugmentation.class));
 439             }
 440         }
 441         return tpAugmentations;
 442     }
 443
 444     public static List<OvsdbTerminationPointAugmentation> readTerminationPointAugmentationFromDataStore( Node node ) {
 445         InstanceIdentifier<Node> bridgeNodeIid = MdsalHelper.createInstanceIdentifier(node.getNodeId());
 446         Node operNode = read(LogicalDatastoreType.OPERATIONAL, bridgeNodeIid);
 447         if(operNode != null){
 448             return extractTerminationPointAugmentations(operNode);
 449         }
 450         return new ArrayList<OvsdbTerminationPointAugmentation>();
 451     }
 452
 453     public static String getInterfaceExternalIdsValue(
 454             OvsdbTerminationPointAugmentation terminationPointAugmentation,String key) {
 455         String value = null;
 456         List<InterfaceExternalIds> pairs = terminationPointAugmentation.getInterfaceExternalIds();
 457         if (pairs != null) {
 458             for (InterfaceExternalIds pair : pairs) {
 459                 if (pair.getKey().equals(key)) {
 460                     value = pair.getExternalIdValue();
 461                 }
 462             }
 463         }
 464         return value;
 465     }
 466
 467     public static Boolean addTerminationPoint(Node bridgeNode, String bridgeName, String portName) {
 468         InstanceIdentifier<TerminationPoint> tpIid =
 469                 MdsalHelper.createTerminationPointInstanceIdentifier(bridgeNode, portName);
 470         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder =
 471                 new OvsdbTerminationPointAugmentationBuilder();
 472
 473         tpAugmentationBuilder.setName(portName);
 474         tpAugmentationBuilder.setInterfaceType(InterfaceTypeInternal.class);
 475         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 476         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
 477         return put(LogicalDatastoreType.CONFIGURATION, tpIid, tpBuilder.build());
 478     }
 479
 480     public static Boolean deleteTerminationPoint(Node bridgeNode, String portName) {
 481         InstanceIdentifier<TerminationPoint> tpIid =
 482                 MdsalHelper.createTerminationPointInstanceIdentifier(bridgeNode, portName);
 483         return delete(LogicalDatastoreType.CONFIGURATION, tpIid);
 484     }
 485
 486     public static Boolean addTerminationPoint(Node bridgeNode, String bridgeName, String portName,
 487             String type, Map<String, String> options) {
 488         InstanceIdentifier<TerminationPoint> tpIid = MdsalHelper.createTerminationPointInstanceIdentifier(
 489                 bridgeNode, portName);
 490         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
 491
 492         tpAugmentationBuilder.setName(portName);
 493         if (type != null) {
 494             tpAugmentationBuilder.setInterfaceType(MdsalHelper.OVSDB_INTERFACE_TYPE_MAP.get(type));
 495         }
 496
 497         List<Options> optionsList = new ArrayList<Options>();
 498         for (Map.Entry<String, String> entry : options.entrySet()) {
 499             OptionsBuilder optionsBuilder = new OptionsBuilder();
 500             optionsBuilder.setKey(new OptionsKey(entry.getKey()));
 501             optionsBuilder.setOption(entry.getKey());
 502             optionsBuilder.setValue(entry.getValue());
 503             optionsList.add(optionsBuilder.build());
 504         }
 505         tpAugmentationBuilder.setOptions(optionsList);
 506
 507         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 508         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
 509         return put(LogicalDatastoreType.CONFIGURATION, tpIid, tpBuilder.build());
 510     }
 511
 512     public static Boolean addTunnelTerminationPoint(Node bridgeNode, String bridgeName, String portName, String type,
 513                                         Map<String, String> options) {
 514         return addTerminationPoint(bridgeNode, bridgeName, portName, type, options);
 515     }
 516
 517     public static Boolean addPatchTerminationPoint(Node node, String bridgeName, String portName, String peerPortName) {
 518         Map<String, String> option = new HashMap<String, String>();
 519         option.put("peer", peerPortName);
 520         return addTerminationPoint(node, bridgeName, portName, PATCH_PORT_TYPE, option);
 521     }
 522
 523     public static String getExternalId(Node node, OvsdbTables table, String key) {
 524         switch (table) {
 525         case BRIDGE:
 526             OvsdbBridgeAugmentation bridge = extractBridgeAugmentation(node);
 527             if (bridge != null) {
 528                 for (BridgeExternalIds bridgeExternaIds :bridge.getBridgeExternalIds()) {
 529                 if (bridgeExternaIds.getBridgeExternalIdKey().equals(key)) {
 530                         return bridgeExternaIds.getBridgeExternalIdValue();
 531                     }
 532                 }
 533             }
 534             break;
 535         case CONTROLLER:
 536             LOG.debug("There is no external_id for OvsdbTables: ", table);
 537             return null;
 538         case OPENVSWITCH:
 539             OvsdbNodeAugmentation ovsdbNode = extractNodeAugmentation(node);
 540             if (ovsdbNode != null) {
 541                 for ( OpenvswitchExternalIds openvswitchExternalIds :ovsdbNode.getOpenvswitchExternalIds()) {
 542                     if (openvswitchExternalIds.getExternalIdKey().equals(key)) {
 543                         return openvswitchExternalIds.getExternalIdValue();
 544                     }
 545                 }
 546             }
 547             break;
 548         case PORT:
 549             List <OvsdbTerminationPointAugmentation> ports = extractTerminationPointAugmentations(node);
 550             for (OvsdbTerminationPointAugmentation port : ports) {
 551                 if (port != null && port.getPortExternalIds() != null) {
 552                     for (PortExternalIds portExternalIds :port.getPortExternalIds()) {
 553                         if (portExternalIds.getExternalIdKey().equals(key)) {
 554                             return portExternalIds.getExternalIdValue();
 555                         }
 556                     }
 557                 }
 558             }
 559             break;
 560         default:
 561             LOG.debug("Couldn't find the specified OvsdbTables: ", table);
 562             return null;
 563         }
 564         return null;
 565     }
 566
 567     public static String getOtherConfig(Node node, OvsdbTables table, String key) {
 568         switch (table) {
 569             case BRIDGE:
 570                 OvsdbBridgeAugmentation bridge = extractBridgeAugmentation(node);
 571                 if (bridge != null) {
 572                     for (BridgeOtherConfigs bridgeOtherConfigs : bridge.getBridgeOtherConfigs()) {
 573                         if (bridgeOtherConfigs.getBridgeOtherConfigKey().equals(key)) {
 574                             return bridgeOtherConfigs.getBridgeOtherConfigValue();
 575                         }
 576                     }
 577                 }
 578                 break;
 579             case CONTROLLER:
 580                 LOG.debug("There is no other_config for OvsdbTables: ", table);
 581                 return null;
 582
 583             case OPENVSWITCH:
 584                 OvsdbNodeAugmentation ovsdbNode = extractNodeAugmentation(node);
 585                 if (ovsdbNode != null) {
 586                     for (OpenvswitchOtherConfigs openvswitchOtherConfigs :ovsdbNode.getOpenvswitchOtherConfigs()){
 587                         if (openvswitchOtherConfigs.getOtherConfigKey().equals(key)) {
 588                             return openvswitchOtherConfigs.getOtherConfigValue();
 589                         }
 590                     }
 591                 }
 592                 break;
 593             case PORT:
 594                 List <OvsdbTerminationPointAugmentation> ports = extractTerminationPointAugmentations(node);
 595                 for (OvsdbTerminationPointAugmentation port : ports) {
 596                     if (port != null && port.getPortOtherConfigs() != null) {
 597                         for (PortOtherConfigs portOtherConfigs : port.getPortOtherConfigs()) {
 598                             if (portOtherConfigs.getOtherConfigKey().equals(key)) {
 599                                 return portOtherConfigs.getOtherConfigValue();
 600                             }
 601                         }
 602                     }
 603                 }
 604                 break;
 605             default:
 606                 LOG.debug("Couldn't find the specified OvsdbTables: ", table);
 607                 return null;
 608         }
 609         return null;
 610     }
 611
 612     public static boolean addVlanToTp(long vlan) {
 613         return false;
 614     }
 615
 616     public static boolean isTunnel(OvsdbTerminationPointAugmentation port) {
 617         return MdsalHelper.createOvsdbInterfaceType(
 618                 port.getInterfaceType()).equals(NetworkHandler.NETWORK_TYPE_VXLAN)
 619                 || MdsalHelper.createOvsdbInterfaceType(
 620                 port.getInterfaceType()).equals(NetworkHandler.NETWORK_TYPE_GRE);
 621     }
 622
 623     public static String getOptionsValue(List<Options> options, String key) {
 624         String value = null;
 625         for (Options option : options) {
 626             if (option.getKey().equals(key)) {
 627                 value = option.getValue();
 628             }
 629         }
 630         return value;
 631     }
 632
 633     private static Topology getOvsdbTopology() {
 634         InstanceIdentifier<Topology> path = InstanceIdentifier
 635                 .create(NetworkTopology.class)
 636                 .child(Topology.class, new TopologyKey(MdsalHelper.OVSDB_TOPOLOGY_ID));
 637
 638         Topology topology = read(LogicalDatastoreType.OPERATIONAL, path);
 639         return topology;
 640     }
 641
 642 }