southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/SouthboundMapper.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, 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.southbound;
   9
  10 import static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.ovsdb.southbound.SouthboundUtil.schemaMismatchLog;
  12
  13 import com.google.common.annotations.VisibleForTesting;
  14 import com.google.common.base.Joiner;
  15 import com.google.common.base.Preconditions;
  16 import com.google.common.base.Splitter;
  17 import com.google.common.collect.ImmutableBiMap;
  18 import com.google.common.net.InetAddresses;
  19 import java.net.Inet4Address;
  20 import java.net.Inet6Address;
  21 import java.net.InetAddress;
  22 import java.net.UnknownHostException;
  23 import java.util.ArrayList;
  24 import java.util.HashMap;
  25 import java.util.HashSet;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.Set;
  29 import org.opendaylight.ovsdb.lib.OvsdbClient;
  30 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
  31 import org.opendaylight.ovsdb.lib.notation.UUID;
  32 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
  33 import org.opendaylight.ovsdb.lib.schema.typed.TypedDatabaseSchema;
  34 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
  35 import org.opendaylight.ovsdb.schema.openvswitch.Controller;
  36 import org.opendaylight.ovsdb.schema.openvswitch.Manager;
  37 import org.opendaylight.ovsdb.schema.openvswitch.OpenVSwitch;
  38 import org.opendaylight.ovsdb.schema.openvswitch.Qos;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeBase;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeNetdev;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeSystem;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeBase;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdk;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkr;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkvhost;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkvhostuser;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkvhostuserclient;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGeneve;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre64;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeInternal;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeIpsecGre;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeIpsecGre64;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeLisp;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypePatch;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeStt;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeSystem;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeTap;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlan;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlanGpe;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeBase;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeEgressPolicer;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxCodel;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxFqCodel;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxHfsc;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxHtb;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxSfq;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntry;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryKey;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntry;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryBuilder;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryKey;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfo;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfoBuilder;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagerEntry;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagerEntryBuilder;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagerEntryKey;
  89 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  90 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  91 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  92 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  93 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  94 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  95 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  96 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  97 import org.opendaylight.yangtools.yang.binding.DataObject;
  98 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  99 import org.opendaylight.yangtools.yang.common.Uint16;
 100 import org.opendaylight.yangtools.yang.common.Uint32;
 101 import org.slf4j.Logger;
 102 import org.slf4j.LoggerFactory;
 103
 104 public final class SouthboundMapper {
 105     private static final Logger LOG = LoggerFactory.getLogger(SouthboundMapper.class);
 106     private static final String N_CONNECTIONS_STR = "n_connections";
 107
 108     @VisibleForTesting
 109     public static final ImmutableBiMap<DatapathTypeBase, String> DATAPATH_TYPE_MAP = ImmutableBiMap.of(
 110             DatapathTypeSystem.VALUE, "system",
 111             DatapathTypeNetdev.VALUE, "netdev");
 112     @VisibleForTesting
 113     public static final ImmutableBiMap<String, InterfaceTypeBase> OVSDB_INTERFACE_TYPE_MAP =
 114         ImmutableBiMap.<String, InterfaceTypeBase>builder()
 115             .put("internal", InterfaceTypeInternal.VALUE)
 116             .put("vxlan", InterfaceTypeVxlan.VALUE)
 117             .put("vxlan-gpe", InterfaceTypeVxlanGpe.VALUE)
 118             .put("patch", InterfaceTypePatch.VALUE)
 119             .put("system", InterfaceTypeSystem.VALUE)
 120             .put("tap", InterfaceTypeTap.VALUE)
 121             .put("geneve", InterfaceTypeGeneve.VALUE)
 122             .put("gre", InterfaceTypeGre.VALUE)
 123             .put("ipsec_gre", InterfaceTypeIpsecGre.VALUE)
 124             .put("gre64", InterfaceTypeGre64.VALUE)
 125             .put("ipsec_gre64", InterfaceTypeIpsecGre64.VALUE)
 126             .put("lisp", InterfaceTypeLisp.VALUE)
 127             .put("dpdk", InterfaceTypeDpdk.VALUE)
 128             .put("dpdkr", InterfaceTypeDpdkr.VALUE)
 129             .put("dpdkvhost", InterfaceTypeDpdkvhost.VALUE)
 130             .put("dpdkvhostuser", InterfaceTypeDpdkvhostuser.VALUE)
 131             .put("dpdkvhostuserclient", InterfaceTypeDpdkvhostuserclient.VALUE)
 132             .put("stt", InterfaceTypeStt.VALUE)
 133             .build();
 134     private static final ImmutableBiMap<QosTypeBase, String> QOS_TYPE_MAP =
 135         ImmutableBiMap.<QosTypeBase, String>builder()
 136             .put(QosTypeLinuxHtb.VALUE, SouthboundConstants.QOS_LINUX_HTB)
 137             .put(QosTypeLinuxHfsc.VALUE, SouthboundConstants.QOS_LINUX_HFSC)
 138             .put(QosTypeLinuxSfq.VALUE, SouthboundConstants.QOS_LINUX_SFQ)
 139             .put(QosTypeLinuxCodel.VALUE, SouthboundConstants.QOS_LINUX_CODEL)
 140             .put(QosTypeLinuxFqCodel.VALUE, SouthboundConstants.QOS_LINUX_FQ_CODEL)
 141             .put(QosTypeEgressPolicer.VALUE, SouthboundConstants.QOS_EGRESS_POLICER)
 142             .build();
 143
 144     private SouthboundMapper() {
 145         // Hidden on purpose
 146     }
 147
 148     public static IpAddress createIpAddress(final InetAddress address) {
 149         IpAddress ip = null;
 150         if (address instanceof Inet4Address) {
 151             ip = createIpAddress((Inet4Address)address);
 152         } else if (address instanceof Inet6Address) {
 153             ip = createIpAddress((Inet6Address)address);
 154         }
 155         return ip;
 156     }
 157
 158     public static IpAddress createIpAddress(final Inet4Address address) {
 159         return IetfInetUtil.INSTANCE.ipAddressFor(address);
 160     }
 161
 162     public static IpAddress createIpAddress(final Inet6Address address) {
 163         Ipv6Address ipv6 = new Ipv6Address(address.getHostAddress());
 164         return new IpAddress(ipv6);
 165     }
 166
 167     public static InstanceIdentifier<Topology> createTopologyInstanceIdentifier() {
 168         return InstanceIdentifier
 169                 .create(NetworkTopology.class)
 170                 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID));
 171     }
 172
 173     public static InstanceIdentifier<Node> createInstanceIdentifier(final NodeId nodeId) {
 174         return createTopologyInstanceIdentifier()
 175                 .child(Node.class,new NodeKey(nodeId));
 176     }
 177
 178     @SuppressWarnings("unchecked")
 179     public static InstanceIdentifier<Node> createInstanceIdentifier(
 180             final InstanceIdentifierCodec instanceIdentifierCodec, final OvsdbConnectionInstance client,
 181             final Bridge bridge) {
 182         InstanceIdentifier<Node> iid;
 183         if (bridge.getExternalIdsColumn() != null
 184                 && bridge.getExternalIdsColumn().getData() != null
 185                 && bridge.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
 186             String iidString = bridge.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY);
 187             iid = (InstanceIdentifier<Node>) instanceIdentifierCodec.bindingDeserializerOrNull(iidString);
 188         } else {
 189             iid = createInstanceIdentifier(client, bridge.getName());
 190         }
 191         return iid;
 192     }
 193
 194     @SuppressWarnings("unchecked")
 195     public static InstanceIdentifier<Node> createInstanceIdentifier(
 196             final InstanceIdentifierCodec instanceIdentifierCodec, final OvsdbConnectionInstance client,
 197             final Controller controller, final String bridgeName) {
 198         InstanceIdentifier<Node> iid;
 199         if (controller.getExternalIdsColumn() != null
 200                 && controller.getExternalIdsColumn().getData() != null
 201                 && controller.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
 202             String iidString = controller.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY);
 203             iid = (InstanceIdentifier<Node>) instanceIdentifierCodec.bindingDeserializerOrNull(iidString);
 204         } else {
 205             iid = createInstanceIdentifier(client, bridgeName);
 206         }
 207         return iid;
 208     }
 209
 210     public static InstanceIdentifier<Node> createInstanceIdentifier(
 211             final OvsdbConnectionInstance client, final String bridgeName) {
 212         String nodeString = client.getNodeKey().getNodeId().getValue()
 213                 + "/bridge/" + bridgeName;
 214         NodeId nodeId = new NodeId(new Uri(nodeString));
 215         return createInstanceIdentifier(nodeId);
 216
 217     }
 218
 219     public static NodeId createManagedNodeId(final InstanceIdentifier<Node> iid) {
 220         NodeKey nodeKey = iid.firstKeyOf(Node.class);
 221         return nodeKey.getNodeId();
 222     }
 223
 224     public static InetAddress createInetAddress(final IpAddress ip) throws UnknownHostException {
 225         if (ip.getIpv4Address() != null) {
 226             return InetAddresses.forString(ip.getIpv4Address().getValue());
 227         } else if (ip.getIpv6Address() != null) {
 228             return InetAddress.getByName(ip.getIpv6Address().getValue());
 229         } else {
 230             throw new UnknownHostException("IP Address has no value");
 231         }
 232     }
 233
 234     public static DatapathId createDatapathId(final Bridge bridge) {
 235         requireNonNull(bridge);
 236         if (bridge.getDatapathIdColumn() == null) {
 237             return null;
 238         } else {
 239             return createDatapathId(bridge.getDatapathIdColumn().getData());
 240         }
 241     }
 242
 243     public static DatapathId createDatapathId(final Set<String> dpids) {
 244         requireNonNull(dpids);
 245         if (dpids.isEmpty()) {
 246             return null;
 247         } else {
 248             String[] dpidArray = new String[dpids.size()];
 249             dpids.toArray(dpidArray);
 250             return createDatapathId(dpidArray[0]);
 251         }
 252     }
 253
 254     public static DatapathId createDatapathId(final String dpid) {
 255         requireNonNull(dpid);
 256         DatapathId datapath;
 257         if (dpid.matches("^[0-9a-fA-F]{16}")) {
 258             Splitter splitter = Splitter.fixedLength(2);
 259             Joiner joiner = Joiner.on(":");
 260             datapath = new DatapathId(joiner.join(splitter.split(dpid)));
 261         } else {
 262             datapath = new DatapathId(dpid);
 263         }
 264         return datapath;
 265     }
 266
 267     public static String createDatapathType(final OvsdbBridgeAugmentation mdsalbridge) {
 268         String datapathtype = DATAPATH_TYPE_MAP.get(DatapathTypeSystem.VALUE);
 269
 270         if (mdsalbridge.getDatapathType() != null && !mdsalbridge.getDatapathType().equals(DatapathTypeBase.VALUE)) {
 271             datapathtype = DATAPATH_TYPE_MAP.get(mdsalbridge.getDatapathType());
 272             if (datapathtype == null) {
 273                 throw new IllegalArgumentException("Unknown datapath type " + mdsalbridge.getDatapathType());
 274             }
 275         }
 276         return datapathtype;
 277     }
 278
 279     public static DatapathTypeBase createDatapathType(final String type) {
 280         if (type.isEmpty()) {
 281             return DatapathTypeSystem.VALUE;
 282         }
 283         return DATAPATH_TYPE_MAP.inverse().get(type);
 284     }
 285
 286     public static Set<String> createOvsdbBridgeProtocols(final OvsdbBridgeAugmentation ovsdbBridgeNode) {
 287         Set<String> protocols = new HashSet<>();
 288         Map<ProtocolEntryKey, ProtocolEntry> entries = ovsdbBridgeNode.getProtocolEntry();
 289         if (entries != null) {
 290             for (ProtocolEntry protocol : entries.values()) {
 291                 final OvsdbBridgeProtocolBase lookup = protocol.getProtocol();
 292                 final String toAdd = SouthboundConstants.OVSDB_PROTOCOL_MAP.get(protocol.getProtocol());
 293                 Preconditions.checkArgument(toAdd != null, "Unknown protocol %s", lookup);
 294                 protocols.add(toAdd);
 295             }
 296         }
 297         return protocols;
 298     }
 299
 300     public static InterfaceTypeBase createInterfaceType(final String type) {
 301         return OVSDB_INTERFACE_TYPE_MAP.get(requireNonNull(type));
 302     }
 303
 304     public static String createOvsdbInterfaceType(final InterfaceTypeBase mdsaltype) {
 305         return OVSDB_INTERFACE_TYPE_MAP.inverse().get(requireNonNull(mdsaltype));
 306     }
 307
 308     public static List<ProtocolEntry> createMdsalProtocols(final Bridge bridge) {
 309         Set<String> protocols = null;
 310         try {
 311             protocols = bridge.getProtocolsColumn().getData();
 312         } catch (SchemaVersionMismatchException e) {
 313             schemaMismatchLog("protocols", "Bridge", e);
 314         }
 315         List<ProtocolEntry> protocolList = new ArrayList<>();
 316         if (protocols != null && !protocols.isEmpty()) {
 317             ImmutableBiMap<String, OvsdbBridgeProtocolBase> mapper = SouthboundConstants.OVSDB_PROTOCOL_MAP.inverse();
 318             for (String protocol : protocols) {
 319                 if (protocol != null) {
 320                     final OvsdbBridgeProtocolBase mapped = mapper.get(protocol);
 321                     if (mapped != null) {
 322                         protocolList.add(new ProtocolEntryBuilder().setProtocol(mapped).build());
 323                     }
 324                 }
 325             }
 326         }
 327         return protocolList;
 328     }
 329
 330     /**
 331      * Create the {@link ControllerEntry} list given an OVSDB {@link Bridge}
 332      * and {@link Controller} rows.
 333      *
 334      * @param bridge the {@link Bridge} to update
 335      * @param updatedControllerRows the list of {@link Controller} controllers with updates
 336      * @return list of {@link ControllerEntry} entries
 337      */
 338     public static List<ControllerEntry> createControllerEntries(final Bridge bridge,
 339                                                                 final Map<UUID, Controller> updatedControllerRows) {
 340
 341         LOG.debug("createControllerEntries Bridge: {}\n, updatedControllerRows: {}",
 342                 bridge, updatedControllerRows);
 343         final Set<UUID> controllerUuids = bridge.getControllerColumn().getData();
 344         final List<ControllerEntry> controllerEntries = new ArrayList<>();
 345         for (UUID controllerUuid : controllerUuids) {
 346             final Controller controller = updatedControllerRows.get(controllerUuid);
 347             addControllerEntries(controllerEntries, controller);
 348         }
 349         LOG.debug("controllerEntries: {}", controllerEntries);
 350         return controllerEntries;
 351     }
 352
 353     /**
 354      * Create the {@link ControllerEntry} list given an MDSAL {@link Node} bridge
 355      * and {@link Controller} rows.
 356      *
 357      * @param bridgeNode the {@link Node} to update
 358      * @param updatedControllerRows the list of {@link Controller} controllers with updates
 359      * @return list of {@link ControllerEntry} entries
 360      */
 361     public static List<ControllerEntry> createControllerEntries(final Node bridgeNode,
 362                                                                 final Map<UUID, Controller> updatedControllerRows) {
 363
 364         LOG.debug("createControllerEntries Bridge 2: {}\n, updatedControllerRows: {}",
 365                 bridgeNode, updatedControllerRows);
 366         final List<ControllerEntry> controllerEntriesCreated = new ArrayList<>();
 367         final OvsdbBridgeAugmentation ovsdbBridgeAugmentation =
 368                 bridgeNode.augmentation(OvsdbBridgeAugmentation.class);
 369         if (ovsdbBridgeAugmentation == null) {
 370             return controllerEntriesCreated;
 371         }
 372
 373         final Map<ControllerEntryKey, ControllerEntry> controllerEntries = ovsdbBridgeAugmentation.getControllerEntry();
 374         if (controllerEntries != null) {
 375             for (ControllerEntry controllerEntry : controllerEntries.values()) {
 376                 final Controller controller = updatedControllerRows.get(
 377                         new UUID(controllerEntry.getControllerUuid().getValue()));
 378                 addControllerEntries(controllerEntriesCreated, controller);
 379             }
 380         }
 381         LOG.debug("controllerEntries: {}", controllerEntriesCreated);
 382         return controllerEntriesCreated;
 383     }
 384
 385     /**
 386      * Add the OVSDB {@link Controller} updates to the MDSAL {@link ControllerEntry} list.
 387      *
 388      * @param controllerEntries the list of {@link ControllerEntry} to update
 389      * @param controller the updated OVSDB {@link Controller}
 390      */
 391     public static void addControllerEntries(final List<ControllerEntry> controllerEntries,
 392                                             final Controller controller) {
 393
 394         if (controller != null && controller.getTargetColumn() != null) {
 395             final String targetString = controller.getTargetColumn().getData();
 396             final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid uuid =
 397                     new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
 398                             .ietf.yang.types.rev130715.Uuid(controller.getUuid().toString());
 399             ControllerEntryBuilder builder = new ControllerEntryBuilder();
 400
 401             if (controller.getMaxBackoffColumn() != null && controller.getMaxBackoffColumn().getData() != null
 402                     && !controller.getMaxBackoffColumn().getData().isEmpty()) {
 403                 builder.setMaxBackoff(Uint32.valueOf(controller.getMaxBackoffColumn().getData().iterator().next()));
 404             }
 405             if (controller.getInactivityProbeColumn() != null && controller.getInactivityProbeColumn().getData() != null
 406                     && !controller.getInactivityProbeColumn().getData().isEmpty()) {
 407                 builder.setInactivityProbe(
 408                     Uint32.valueOf(controller.getInactivityProbeColumn().getData().iterator().next()));
 409             }
 410             controllerEntries.add(builder
 411                     .setTarget(new Uri(targetString))
 412                     .setIsConnected(controller.getIsConnectedColumn().getData())
 413                     .setControllerUuid(uuid).build());
 414         }
 415     }
 416
 417     // This is not called from anywhere but test. Do we need this?
 418     public static Map<UUID, Controller> createOvsdbController(final OvsdbBridgeAugmentation omn,
 419             final DatabaseSchema dbSchema) {
 420         Map<ControllerEntryKey, ControllerEntry> controllerEntries = omn.getControllerEntry();
 421         Map<UUID,Controller> controllerMap = new HashMap<>();
 422         if (controllerEntries != null && !controllerEntries.isEmpty()) {
 423             for (ControllerEntry controllerEntry : controllerEntries.values()) {
 424                 String controllerNamedUuid = "Controller_" + getRandomUuid();
 425                 Controller controller = TypedDatabaseSchema.of(dbSchema).getTypedRowWrapper(Controller.class);
 426                 controller.setTarget(controllerEntry.getTarget().getValue());
 427                 controllerMap.put(new UUID(controllerNamedUuid), controller);
 428             }
 429         }
 430         return controllerMap;
 431     }
 432
 433     public static String getRandomUuid() {
 434         return "Random_" + java.util.UUID.randomUUID().toString().replace("-", "");
 435     }
 436
 437     public static ConnectionInfo createConnectionInfo(final OvsdbClient client) {
 438         ConnectionInfoBuilder connectionInfoBuilder = new ConnectionInfoBuilder();
 439         connectionInfoBuilder.setRemoteIp(createIpAddress(client.getConnectionInfo().getRemoteAddress()));
 440         connectionInfoBuilder.setRemotePort(new PortNumber(Uint16.valueOf(client.getConnectionInfo().getRemotePort())));
 441         connectionInfoBuilder.setLocalIp(createIpAddress(client.getConnectionInfo().getLocalAddress()));
 442         connectionInfoBuilder.setLocalPort(new PortNumber(Uint16.valueOf(client.getConnectionInfo().getLocalPort())));
 443         return connectionInfoBuilder.build();
 444     }
 445
 446     public static ConnectionInfo suppressLocalIpPort(final ConnectionInfo connectionInfo) {
 447         ConnectionInfoBuilder connectionInfoBuilder = new ConnectionInfoBuilder();
 448         connectionInfoBuilder.setRemoteIp(connectionInfo.getRemoteIp());
 449         connectionInfoBuilder.setRemotePort(connectionInfo.getRemotePort());
 450         return connectionInfoBuilder.build();
 451     }
 452
 453     /**
 454      * Create the {@link ManagerEntry} list given an OVSDB {@link OpenVSwitch}
 455      * and {@link Manager} rows.
 456      *
 457      * @param ovsdbNode the {@link OpenVSwitch} to update
 458      * @param updatedManagerRows the list of {@link Manager} managers with updates
 459      * @return list of {@link ManagerEntry} entries
 460      */
 461     public static List<ManagerEntry> createManagerEntries(final OpenVSwitch ovsdbNode,
 462                                                                 final Map<UUID, Manager> updatedManagerRows) {
 463
 464         LOG.debug("createManagerEntries OpenVSwitch: {}\n, updatedManagerRows: {}",
 465                 ovsdbNode, updatedManagerRows);
 466         final Set<UUID> managerUuids = ovsdbNode.getManagerOptionsColumn().getData();
 467         final List<ManagerEntry> managerEntries = new ArrayList<>();
 468         for (UUID managerUuid : managerUuids) {
 469             final Manager manager = updatedManagerRows.get(managerUuid);
 470             addManagerEntries(managerEntries, manager);
 471         }
 472         LOG.debug("managerEntries: {}", managerEntries);
 473         return managerEntries;
 474     }
 475
 476     /**
 477      * Create the {@link ManagerEntry} list given an MDSAL {@link Node} ovsdbNode
 478      * and {@link Manager} rows.
 479      *
 480      * @param ovsdbNode the {@link Node} to update
 481      * @param updatedManagerRows the list of {@link Manager} managers with updates
 482      * @return list of {@link ManagerEntry} entries
 483      */
 484     public static List<ManagerEntry> createManagerEntries(final Node ovsdbNode,
 485                                                                 final Map<Uri, Manager> updatedManagerRows) {
 486
 487         LOG.debug("createManagerEntries based on OVSDB Node: {}\n, updatedManagerRows: {}",
 488                 ovsdbNode, updatedManagerRows);
 489         final List<ManagerEntry> managerEntriesCreated = new ArrayList<>();
 490         final OvsdbNodeAugmentation ovsdbNodeAugmentation =
 491                 ovsdbNode.augmentation(OvsdbNodeAugmentation.class);
 492         if (ovsdbNodeAugmentation == null) {
 493             return managerEntriesCreated;
 494         }
 495
 496         final Map<ManagerEntryKey, ManagerEntry> managerEntries = ovsdbNodeAugmentation.getManagerEntry();
 497         if (managerEntries != null) {
 498             for (ManagerEntry managerEntry : managerEntries.values()) {
 499                 final Manager manager = updatedManagerRows.get(managerEntry.getTarget());
 500                 addManagerEntries(managerEntriesCreated, manager);
 501             }
 502         }
 503         LOG.debug("managerEntries: {}", managerEntriesCreated);
 504         return managerEntriesCreated;
 505     }
 506
 507     /**
 508      * Add the OVSDB {@link Manager} updates to the MDSAL {@link ManagerEntry} list.
 509      *
 510      * @param managerEntries the list of {@link ManagerEntry} to update
 511      * @param manager the updated OVSDB {@link Manager}
 512      */
 513     public static void addManagerEntries(final List<ManagerEntry> managerEntries,
 514                                             final Manager manager) {
 515
 516         if (manager != null && manager.getTargetColumn() != null) {
 517             Uint32 numberOfConnections = Uint32.ZERO;
 518             final String targetString = manager.getTargetColumn().getData();
 519
 520             final Map<String, String> statusAttributeMap =
 521                             manager.getStatusColumn() == null ? null : manager.getStatusColumn().getData();
 522             if (statusAttributeMap != null && statusAttributeMap.containsKey(N_CONNECTIONS_STR)) {
 523                 String numberOfConnectionValueStr = statusAttributeMap.get(N_CONNECTIONS_STR);
 524                 numberOfConnections = Uint32.valueOf(numberOfConnectionValueStr);
 525             } else {
 526                 final boolean isConnected = manager.getIsConnectedColumn().getData();
 527                 if (isConnected) {
 528                     numberOfConnections = Uint32.ONE;
 529                 }
 530             }
 531             managerEntries.add(new ManagerEntryBuilder()
 532                     .setTarget(new Uri(targetString))
 533                     .setNumberOfConnections(numberOfConnections)
 534                     .setConnected(manager.getIsConnectedColumn().getData()).build());
 535         }
 536     }
 537
 538     /**
 539      * Return the MD-SAL QoS type class corresponding to the QoS type {@link Qos}.
 540      *
 541      * @param type the QoS type to match {@link String}
 542      * @return class matching the input QoS type {@link QosTypeBase}
 543      */
 544     public static QosTypeBase createQosType(final String type) {
 545         requireNonNull(type);
 546         if (type.isEmpty()) {
 547             LOG.info("QoS type not supplied");
 548             return QosTypeBase.VALUE;
 549         }
 550
 551         ImmutableBiMap<String, QosTypeBase> mapper = QOS_TYPE_MAP.inverse();
 552         if (mapper.get(type) == null) {
 553             LOG.info("QoS type not found in model: {}", type);
 554             return QosTypeBase.VALUE;
 555         } else {
 556             return mapper.get(type);
 557         }
 558     }
 559
 560     public static String createQosType(final QosTypeBase qosTypeClass) {
 561         String qosType = QOS_TYPE_MAP.get(QosTypeBase.VALUE);
 562
 563         if (qosTypeClass != null && !qosTypeClass.equals(QosTypeBase.VALUE)) {
 564             qosType = QOS_TYPE_MAP.get(qosTypeClass);
 565             if (qosType == null) {
 566                 throw new IllegalArgumentException("Unknown QoS type" + qosTypeClass);
 567             }
 568         }
 569         return qosType;
 570     }
 571
 572
 573     public static InstanceIdentifier<Node> getInstanceIdentifier(final InstanceIdentifierCodec instanceIdentifierCodec,
 574             final OpenVSwitch ovs) {
 575         if (ovs.getExternalIdsColumn() != null
 576                 && ovs.getExternalIdsColumn().getData() != null
 577                 && ovs.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
 578             String iidString = ovs.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY);
 579             return (InstanceIdentifier<Node>) instanceIdentifierCodec.bindingDeserializerOrNull(iidString);
 580         } else {
 581             String nodeString = SouthboundConstants.OVSDB_URI_PREFIX + "://" + SouthboundConstants.UUID + "/"
 582                     + ovs.getUuid().toString();
 583             NodeId nodeId = new NodeId(new Uri(nodeString));
 584             NodeKey nodeKey = new NodeKey(nodeId);
 585             return InstanceIdentifier.builder(NetworkTopology.class)
 586                     .child(Topology.class,new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID))
 587                     .child(Node.class,nodeKey)
 588                     .build();
 589         }
 590     }
 591
 592     public static Map<InstanceIdentifier<?>, DataObject> extractTerminationPointConfigurationChanges(
 593             final Node bridgeNode) {
 594         Map<InstanceIdentifier<?>, DataObject> changes = new HashMap<>();
 595         final InstanceIdentifier<Node> bridgeNodeIid =
 596                 SouthboundMapper.createInstanceIdentifier(bridgeNode.getNodeId());
 597         changes.put(bridgeNodeIid, bridgeNode);
 598
 599         Map<TerminationPointKey, TerminationPoint> terminationPoints = bridgeNode.getTerminationPoint();
 600         if (terminationPoints != null) {
 601             for (TerminationPoint tp : terminationPoints.values()) {
 602                 OvsdbTerminationPointAugmentation ovsdbTerminationPointAugmentation =
 603                         tp.augmentation(OvsdbTerminationPointAugmentation.class);
 604                 if (ovsdbTerminationPointAugmentation != null) {
 605                     final InstanceIdentifier<OvsdbTerminationPointAugmentation> tpIid =
 606                             bridgeNodeIid
 607                                     .child(TerminationPoint.class, new TerminationPointKey(tp.getTpId()))
 608                                     .builder()
 609                                     .augmentation(OvsdbTerminationPointAugmentation.class)
 610                                     .build();
 611                     changes.put(tpIid, ovsdbTerminationPointAugmentation);
 612                 }
 613             }
 614         }
 615         return changes;
 616     }
 617 }