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.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.create(NetworkTopology.class)
 169             .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID));
 170     }
 171
 172     public static InstanceIdentifier<Node> createInstanceIdentifier(final NodeId nodeId) {
 173         return createTopologyInstanceIdentifier().child(Node.class, new NodeKey(nodeId));
 174     }
 175
 176     @SuppressWarnings("unchecked")
 177     public static InstanceIdentifier<Node> createInstanceIdentifier(
 178             final InstanceIdentifierCodec instanceIdentifierCodec, final OvsdbConnectionInstance client,
 179             final Bridge bridge) {
 180         InstanceIdentifier<Node> iid;
 181         if (bridge.getExternalIdsColumn() != null
 182                 && bridge.getExternalIdsColumn().getData() != null
 183                 && bridge.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
 184             String iidString = bridge.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY);
 185             iid = (InstanceIdentifier<Node>) instanceIdentifierCodec.bindingDeserializerOrNull(iidString);
 186         } else {
 187             iid = createInstanceIdentifier(client, bridge.getName());
 188         }
 189         return iid;
 190     }
 191
 192     @SuppressWarnings("unchecked")
 193     public static InstanceIdentifier<Node> createInstanceIdentifier(
 194             final InstanceIdentifierCodec instanceIdentifierCodec, final OvsdbConnectionInstance client,
 195             final Controller controller, final String bridgeName) {
 196         InstanceIdentifier<Node> iid;
 197         if (controller.getExternalIdsColumn() != null
 198                 && controller.getExternalIdsColumn().getData() != null
 199                 && controller.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
 200             String iidString = controller.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY);
 201             iid = (InstanceIdentifier<Node>) instanceIdentifierCodec.bindingDeserializerOrNull(iidString);
 202         } else {
 203             iid = createInstanceIdentifier(client, bridgeName);
 204         }
 205         return iid;
 206     }
 207
 208     public static InstanceIdentifier<Node> createInstanceIdentifier(
 209             final OvsdbConnectionInstance client, final String bridgeName) {
 210         String nodeString = client.getNodeKey().getNodeId().getValue()
 211                 + "/bridge/" + bridgeName;
 212         NodeId nodeId = new NodeId(new Uri(nodeString));
 213         return createInstanceIdentifier(nodeId);
 214
 215     }
 216
 217     public static NodeId createManagedNodeId(final InstanceIdentifier<Node> iid) {
 218         NodeKey nodeKey = iid.firstKeyOf(Node.class);
 219         return nodeKey.getNodeId();
 220     }
 221
 222     public static InetAddress createInetAddress(final IpAddress ip) throws UnknownHostException {
 223         if (ip.getIpv4Address() != null) {
 224             return InetAddresses.forString(ip.getIpv4Address().getValue());
 225         } else if (ip.getIpv6Address() != null) {
 226             return InetAddress.getByName(ip.getIpv6Address().getValue());
 227         } else {
 228             throw new UnknownHostException("IP Address has no value");
 229         }
 230     }
 231
 232     public static DatapathId createDatapathId(final Bridge bridge) {
 233         requireNonNull(bridge);
 234         if (bridge.getDatapathIdColumn() == null) {
 235             return null;
 236         } else {
 237             return createDatapathId(bridge.getDatapathIdColumn().getData());
 238         }
 239     }
 240
 241     public static DatapathId createDatapathId(final Set<String> dpids) {
 242         requireNonNull(dpids);
 243         if (dpids.isEmpty()) {
 244             return null;
 245         } else {
 246             String[] dpidArray = new String[dpids.size()];
 247             dpids.toArray(dpidArray);
 248             return createDatapathId(dpidArray[0]);
 249         }
 250     }
 251
 252     public static DatapathId createDatapathId(final String dpid) {
 253         requireNonNull(dpid);
 254         DatapathId datapath;
 255         if (dpid.matches("^[0-9a-fA-F]{16}")) {
 256             Splitter splitter = Splitter.fixedLength(2);
 257             Joiner joiner = Joiner.on(":");
 258             datapath = new DatapathId(joiner.join(splitter.split(dpid)));
 259         } else {
 260             datapath = new DatapathId(dpid);
 261         }
 262         return datapath;
 263     }
 264
 265     public static String createDatapathType(final OvsdbBridgeAugmentation mdsalbridge) {
 266         String datapathtype = DATAPATH_TYPE_MAP.get(DatapathTypeSystem.VALUE);
 267
 268         if (mdsalbridge.getDatapathType() != null && !mdsalbridge.getDatapathType().equals(DatapathTypeBase.VALUE)) {
 269             datapathtype = DATAPATH_TYPE_MAP.get(mdsalbridge.getDatapathType());
 270             if (datapathtype == null) {
 271                 throw new IllegalArgumentException("Unknown datapath type " + mdsalbridge.getDatapathType());
 272             }
 273         }
 274         return datapathtype;
 275     }
 276
 277     public static DatapathTypeBase createDatapathType(final String type) {
 278         if (type.isEmpty()) {
 279             return DatapathTypeSystem.VALUE;
 280         }
 281         return DATAPATH_TYPE_MAP.inverse().get(type);
 282     }
 283
 284     public static Set<String> createOvsdbBridgeProtocols(final OvsdbBridgeAugmentation ovsdbBridgeNode) {
 285         Set<String> protocols = new HashSet<>();
 286         Map<ProtocolEntryKey, ProtocolEntry> entries = ovsdbBridgeNode.getProtocolEntry();
 287         if (entries != null) {
 288             for (ProtocolEntry protocol : entries.values()) {
 289                 final OvsdbBridgeProtocolBase lookup = protocol.getProtocol();
 290                 final String toAdd = SouthboundConstants.OVSDB_PROTOCOL_MAP.get(protocol.getProtocol());
 291                 Preconditions.checkArgument(toAdd != null, "Unknown protocol %s", lookup);
 292                 protocols.add(toAdd);
 293             }
 294         }
 295         return protocols;
 296     }
 297
 298     public static InterfaceTypeBase createInterfaceType(final String type) {
 299         return OVSDB_INTERFACE_TYPE_MAP.get(requireNonNull(type));
 300     }
 301
 302     public static String createOvsdbInterfaceType(final InterfaceTypeBase mdsaltype) {
 303         return OVSDB_INTERFACE_TYPE_MAP.inverse().get(requireNonNull(mdsaltype));
 304     }
 305
 306     public static List<ProtocolEntry> createMdsalProtocols(final Bridge bridge) {
 307         Set<String> protocols = null;
 308         try {
 309             protocols = bridge.getProtocolsColumn().getData();
 310         } catch (SchemaVersionMismatchException e) {
 311             schemaMismatchLog("protocols", "Bridge", e);
 312         }
 313         List<ProtocolEntry> protocolList = new ArrayList<>();
 314         if (protocols != null && !protocols.isEmpty()) {
 315             ImmutableBiMap<String, OvsdbBridgeProtocolBase> mapper = SouthboundConstants.OVSDB_PROTOCOL_MAP.inverse();
 316             for (String protocol : protocols) {
 317                 if (protocol != null) {
 318                     final OvsdbBridgeProtocolBase mapped = mapper.get(protocol);
 319                     if (mapped != null) {
 320                         protocolList.add(new ProtocolEntryBuilder().setProtocol(mapped).build());
 321                     }
 322                 }
 323             }
 324         }
 325         return protocolList;
 326     }
 327
 328     /**
 329      * Create the {@link ControllerEntry} list given an OVSDB {@link Bridge}
 330      * and {@link Controller} rows.
 331      *
 332      * @param bridge the {@link Bridge} to update
 333      * @param updatedControllerRows the list of {@link Controller} controllers with updates
 334      * @return list of {@link ControllerEntry} entries
 335      */
 336     public static List<ControllerEntry> createControllerEntries(final Bridge bridge,
 337                                                                 final Map<UUID, Controller> updatedControllerRows) {
 338
 339         LOG.debug("createControllerEntries Bridge: {}\n, updatedControllerRows: {}",
 340                 bridge, updatedControllerRows);
 341         final Set<UUID> controllerUuids = bridge.getControllerColumn().getData();
 342         final List<ControllerEntry> controllerEntries = new ArrayList<>();
 343         for (UUID controllerUuid : controllerUuids) {
 344             final Controller controller = updatedControllerRows.get(controllerUuid);
 345             addControllerEntries(controllerEntries, controller);
 346         }
 347         LOG.debug("controllerEntries: {}", controllerEntries);
 348         return controllerEntries;
 349     }
 350
 351     /**
 352      * Create the {@link ControllerEntry} list given an MDSAL {@link Node} bridge
 353      * and {@link Controller} rows.
 354      *
 355      * @param bridgeNode the {@link Node} to update
 356      * @param updatedControllerRows the list of {@link Controller} controllers with updates
 357      * @return list of {@link ControllerEntry} entries
 358      */
 359     public static List<ControllerEntry> createControllerEntries(final Node bridgeNode,
 360                                                                 final Map<UUID, Controller> updatedControllerRows) {
 361
 362         LOG.debug("createControllerEntries Bridge 2: {}\n, updatedControllerRows: {}",
 363                 bridgeNode, updatedControllerRows);
 364         final List<ControllerEntry> controllerEntriesCreated = new ArrayList<>();
 365         final OvsdbBridgeAugmentation ovsdbBridgeAugmentation =
 366                 bridgeNode.augmentation(OvsdbBridgeAugmentation.class);
 367         if (ovsdbBridgeAugmentation == null) {
 368             return controllerEntriesCreated;
 369         }
 370
 371         final Map<ControllerEntryKey, ControllerEntry> controllerEntries = ovsdbBridgeAugmentation.getControllerEntry();
 372         if (controllerEntries != null) {
 373             for (ControllerEntry controllerEntry : controllerEntries.values()) {
 374                 final Controller controller = updatedControllerRows.get(
 375                         new UUID(controllerEntry.getControllerUuid().getValue()));
 376                 addControllerEntries(controllerEntriesCreated, controller);
 377             }
 378         }
 379         LOG.debug("controllerEntries: {}", controllerEntriesCreated);
 380         return controllerEntriesCreated;
 381     }
 382
 383     /**
 384      * Add the OVSDB {@link Controller} updates to the MDSAL {@link ControllerEntry} list.
 385      *
 386      * @param controllerEntries the list of {@link ControllerEntry} to update
 387      * @param controller the updated OVSDB {@link Controller}
 388      */
 389     public static void addControllerEntries(final List<ControllerEntry> controllerEntries,
 390                                             final Controller controller) {
 391
 392         if (controller != null && controller.getTargetColumn() != null) {
 393             final String targetString = controller.getTargetColumn().getData();
 394             final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid uuid =
 395                     new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
 396                             .ietf.yang.types.rev130715.Uuid(controller.getUuid().toString());
 397             ControllerEntryBuilder builder = new ControllerEntryBuilder();
 398
 399             if (controller.getMaxBackoffColumn() != null && controller.getMaxBackoffColumn().getData() != null
 400                     && !controller.getMaxBackoffColumn().getData().isEmpty()) {
 401                 builder.setMaxBackoff(Uint32.valueOf(controller.getMaxBackoffColumn().getData().iterator().next()));
 402             }
 403             if (controller.getInactivityProbeColumn() != null && controller.getInactivityProbeColumn().getData() != null
 404                     && !controller.getInactivityProbeColumn().getData().isEmpty()) {
 405                 builder.setInactivityProbe(
 406                     Uint32.valueOf(controller.getInactivityProbeColumn().getData().iterator().next()));
 407             }
 408             controllerEntries.add(builder
 409                     .setTarget(new Uri(targetString))
 410                     .setIsConnected(controller.getIsConnectedColumn().getData())
 411                     .setControllerUuid(uuid).build());
 412         }
 413     }
 414
 415     // This is not called from anywhere but test. Do we need this?
 416     public static Map<UUID, Controller> createOvsdbController(final OvsdbBridgeAugmentation omn,
 417             final DatabaseSchema dbSchema) {
 418         Map<ControllerEntryKey, ControllerEntry> controllerEntries = omn.getControllerEntry();
 419         Map<UUID,Controller> controllerMap = new HashMap<>();
 420         if (controllerEntries != null && !controllerEntries.isEmpty()) {
 421             for (ControllerEntry controllerEntry : controllerEntries.values()) {
 422                 String controllerNamedUuid = "Controller_" + getRandomUuid();
 423                 Controller controller = TypedDatabaseSchema.of(dbSchema).getTypedRowWrapper(Controller.class);
 424                 controller.setTarget(controllerEntry.getTarget().getValue());
 425                 controllerMap.put(new UUID(controllerNamedUuid), controller);
 426             }
 427         }
 428         return controllerMap;
 429     }
 430
 431     public static String getRandomUuid() {
 432         return "Random_" + java.util.UUID.randomUUID().toString().replace("-", "");
 433     }
 434
 435     public static ConnectionInfo createConnectionInfo(final OvsdbClient client) {
 436         ConnectionInfoBuilder connectionInfoBuilder = new ConnectionInfoBuilder();
 437         connectionInfoBuilder.setRemoteIp(createIpAddress(client.getConnectionInfo().getRemoteAddress()));
 438         connectionInfoBuilder.setRemotePort(new PortNumber(Uint16.valueOf(client.getConnectionInfo().getRemotePort())));
 439         connectionInfoBuilder.setLocalIp(createIpAddress(client.getConnectionInfo().getLocalAddress()));
 440         connectionInfoBuilder.setLocalPort(new PortNumber(Uint16.valueOf(client.getConnectionInfo().getLocalPort())));
 441         return connectionInfoBuilder.build();
 442     }
 443
 444     public static ConnectionInfo suppressLocalIpPort(final ConnectionInfo connectionInfo) {
 445         ConnectionInfoBuilder connectionInfoBuilder = new ConnectionInfoBuilder();
 446         connectionInfoBuilder.setRemoteIp(connectionInfo.getRemoteIp());
 447         connectionInfoBuilder.setRemotePort(connectionInfo.getRemotePort());
 448         return connectionInfoBuilder.build();
 449     }
 450
 451     /**
 452      * Create the {@link ManagerEntry} list given an OVSDB {@link OpenVSwitch}
 453      * and {@link Manager} rows.
 454      *
 455      * @param ovsdbNode the {@link OpenVSwitch} to update
 456      * @param updatedManagerRows the list of {@link Manager} managers with updates
 457      * @return list of {@link ManagerEntry} entries
 458      */
 459     public static List<ManagerEntry> createManagerEntries(final OpenVSwitch ovsdbNode,
 460                                                                 final Map<UUID, Manager> updatedManagerRows) {
 461
 462         LOG.debug("createManagerEntries OpenVSwitch: {}\n, updatedManagerRows: {}",
 463                 ovsdbNode, updatedManagerRows);
 464         final Set<UUID> managerUuids = ovsdbNode.getManagerOptionsColumn().getData();
 465         final List<ManagerEntry> managerEntries = new ArrayList<>();
 466         for (UUID managerUuid : managerUuids) {
 467             final Manager manager = updatedManagerRows.get(managerUuid);
 468             addManagerEntries(managerEntries, manager);
 469         }
 470         LOG.debug("managerEntries: {}", managerEntries);
 471         return managerEntries;
 472     }
 473
 474     /**
 475      * Create the {@link ManagerEntry} list given an MDSAL {@link Node} ovsdbNode
 476      * and {@link Manager} rows.
 477      *
 478      * @param ovsdbNode the {@link Node} to update
 479      * @param updatedManagerRows the list of {@link Manager} managers with updates
 480      * @return list of {@link ManagerEntry} entries
 481      */
 482     public static List<ManagerEntry> createManagerEntries(final Node ovsdbNode,
 483                                                                 final Map<Uri, Manager> updatedManagerRows) {
 484
 485         LOG.debug("createManagerEntries based on OVSDB Node: {}\n, updatedManagerRows: {}",
 486                 ovsdbNode, updatedManagerRows);
 487         final List<ManagerEntry> managerEntriesCreated = new ArrayList<>();
 488         final OvsdbNodeAugmentation ovsdbNodeAugmentation =
 489                 ovsdbNode.augmentation(OvsdbNodeAugmentation.class);
 490         if (ovsdbNodeAugmentation == null) {
 491             return managerEntriesCreated;
 492         }
 493
 494         final Map<ManagerEntryKey, ManagerEntry> managerEntries = ovsdbNodeAugmentation.getManagerEntry();
 495         if (managerEntries != null) {
 496             for (ManagerEntry managerEntry : managerEntries.values()) {
 497                 final Manager manager = updatedManagerRows.get(managerEntry.getTarget());
 498                 addManagerEntries(managerEntriesCreated, manager);
 499             }
 500         }
 501         LOG.debug("managerEntries: {}", managerEntriesCreated);
 502         return managerEntriesCreated;
 503     }
 504
 505     /**
 506      * Add the OVSDB {@link Manager} updates to the MDSAL {@link ManagerEntry} list.
 507      *
 508      * @param managerEntries the list of {@link ManagerEntry} to update
 509      * @param manager the updated OVSDB {@link Manager}
 510      */
 511     public static void addManagerEntries(final List<ManagerEntry> managerEntries,
 512                                             final Manager manager) {
 513
 514         if (manager != null && manager.getTargetColumn() != null) {
 515             Uint32 numberOfConnections = Uint32.ZERO;
 516             final String targetString = manager.getTargetColumn().getData();
 517
 518             final Map<String, String> statusAttributeMap =
 519                             manager.getStatusColumn() == null ? null : manager.getStatusColumn().getData();
 520             if (statusAttributeMap != null && statusAttributeMap.containsKey(N_CONNECTIONS_STR)) {
 521                 String numberOfConnectionValueStr = statusAttributeMap.get(N_CONNECTIONS_STR);
 522                 numberOfConnections = Uint32.valueOf(numberOfConnectionValueStr);
 523             } else {
 524                 final boolean isConnected = manager.getIsConnectedColumn().getData();
 525                 if (isConnected) {
 526                     numberOfConnections = Uint32.ONE;
 527                 }
 528             }
 529             managerEntries.add(new ManagerEntryBuilder()
 530                     .setTarget(new Uri(targetString))
 531                     .setNumberOfConnections(numberOfConnections)
 532                     .setConnected(manager.getIsConnectedColumn().getData()).build());
 533         }
 534     }
 535
 536     /**
 537      * Return the MD-SAL QoS type class corresponding to the QoS type {@link Qos}.
 538      *
 539      * @param type the QoS type to match {@link String}
 540      * @return class matching the input QoS type {@link QosTypeBase}
 541      */
 542     public static QosTypeBase createQosType(final String type) {
 543         requireNonNull(type);
 544         if (type.isEmpty()) {
 545             LOG.info("QoS type not supplied");
 546             return QosTypeBase.VALUE;
 547         }
 548
 549         ImmutableBiMap<String, QosTypeBase> mapper = QOS_TYPE_MAP.inverse();
 550         if (mapper.get(type) == null) {
 551             LOG.info("QoS type not found in model: {}", type);
 552             return QosTypeBase.VALUE;
 553         } else {
 554             return mapper.get(type);
 555         }
 556     }
 557
 558     public static String createQosType(final QosTypeBase qosTypeClass) {
 559         String qosType = QOS_TYPE_MAP.get(QosTypeBase.VALUE);
 560
 561         if (qosTypeClass != null && !qosTypeClass.equals(QosTypeBase.VALUE)) {
 562             qosType = QOS_TYPE_MAP.get(qosTypeClass);
 563             if (qosType == null) {
 564                 throw new IllegalArgumentException("Unknown QoS type" + qosTypeClass);
 565             }
 566         }
 567         return qosType;
 568     }
 569
 570
 571     public static InstanceIdentifier<Node> getInstanceIdentifier(final InstanceIdentifierCodec instanceIdentifierCodec,
 572             final OpenVSwitch ovs) {
 573         if (ovs.getExternalIdsColumn() != null
 574                 && ovs.getExternalIdsColumn().getData() != null
 575                 && ovs.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
 576             String iidString = ovs.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY);
 577             return (InstanceIdentifier<Node>) instanceIdentifierCodec.bindingDeserializerOrNull(iidString);
 578         } else {
 579             String nodeString = SouthboundConstants.OVSDB_URI_PREFIX + "://" + SouthboundConstants.UUID + "/"
 580                     + ovs.getUuid().toString();
 581             NodeId nodeId = new NodeId(new Uri(nodeString));
 582             NodeKey nodeKey = new NodeKey(nodeId);
 583             return InstanceIdentifier.builder(NetworkTopology.class)
 584                     .child(Topology.class,new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID))
 585                     .child(Node.class,nodeKey)
 586                     .build();
 587         }
 588     }
 589
 590     public static Map<InstanceIdentifier<?>, DataObject> extractTerminationPointConfigurationChanges(
 591             final Node bridgeNode) {
 592         Map<InstanceIdentifier<?>, DataObject> changes = new HashMap<>();
 593         final InstanceIdentifier<Node> bridgeNodeIid =
 594                 SouthboundMapper.createInstanceIdentifier(bridgeNode.getNodeId());
 595         changes.put(bridgeNodeIid, bridgeNode);
 596
 597         Map<TerminationPointKey, TerminationPoint> terminationPoints = bridgeNode.getTerminationPoint();
 598         if (terminationPoints != null) {
 599             for (TerminationPoint tp : terminationPoints.values()) {
 600                 OvsdbTerminationPointAugmentation ovsdbTerminationPointAugmentation =
 601                         tp.augmentation(OvsdbTerminationPointAugmentation.class);
 602                 if (ovsdbTerminationPointAugmentation != null) {
 603                     final InstanceIdentifier<OvsdbTerminationPointAugmentation> tpIid =
 604                             bridgeNodeIid
 605                                     .child(TerminationPoint.class, new TerminationPointKey(tp.getTpId()))
 606                                     .builder()
 607                                     .augmentation(OvsdbTerminationPointAugmentation.class)
 608                                     .build();
 609                     changes.put(tpIid, ovsdbTerminationPointAugmentation);
 610                 }
 611             }
 612         }
 613         return changes;
 614     }
 615 }