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