hwvtepsouthbound/hwvtepsouthbound-impl/src/main/java/org/opendaylight/ovsdb/hwvtepsouthbound/HwvtepSouthboundUtil.java

   1 /*
   2  * Copyright (c) 2015 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.ovsdb.hwvtepsouthbound;
  10
  11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  12 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  13 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  14 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  15 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  16 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalRef;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalSwitchAttributes;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.ConnectionInfo;
  21 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  22 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  23 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 import com.google.common.base.Optional;
  28 import com.google.common.base.Preconditions;
  29 import com.google.common.util.concurrent.CheckedFuture;
  30
  31 public class HwvtepSouthboundUtil {
  32
  33     private static final Logger LOG = LoggerFactory.getLogger(HwvtepSouthboundUtil.class);
  34     private static final String SCHEMA_VERSION_MISMATCH =
  35             "{} column for {} table is not supported by this version of the {} schema: {}";
  36
  37     private static InstanceIdentifierCodec instanceIdentifierCodec;
  38
  39     private HwvtepSouthboundUtil() {
  40         // Prevent instantiating a utility class
  41     }
  42
  43     public static void setInstanceIdentifierCodec(InstanceIdentifierCodec iidc) {
  44         instanceIdentifierCodec = iidc;
  45     }
  46
  47     public static InstanceIdentifierCodec getInstanceIdentifierCodec() {
  48         return instanceIdentifierCodec;
  49     }
  50
  51     public static String serializeInstanceIdentifier(InstanceIdentifier<?> iid) {
  52         return instanceIdentifierCodec.serialize(iid);
  53     }
  54
  55     public static InstanceIdentifier<?> deserializeInstanceIdentifier(String iidString) {
  56         InstanceIdentifier<?> result = null;
  57         try {
  58             result = instanceIdentifierCodec.bindingDeserializer(iidString);
  59         } catch (DeserializationException e) {
  60             LOG.warn("Unable to deserialize iidString", e);
  61         }
  62         return result;
  63     }
  64
  65     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> Optional<D> readNode(
  66                     ReadWriteTransaction transaction, final InstanceIdentifier<D> connectionIid) {
  67         Optional<D> node = Optional.absent();
  68         try {
  69             node = transaction.read(LogicalDatastoreType.OPERATIONAL, connectionIid).checkedGet();
  70         } catch (final ReadFailedException e) {
  71             LOG.warn("Read Operational/DS for Node failed! {}", connectionIid, e);
  72         }
  73         return node;
  74     }
  75
  76     public static Optional<HwvtepGlobalAugmentation> getManagingNode(DataBroker db,
  77                     HwvtepPhysicalSwitchAttributes pNode) {
  78         Preconditions.checkNotNull(pNode);
  79         Optional<HwvtepGlobalAugmentation> result = null;
  80         HwvtepGlobalRef ref = pNode.getManagedBy();
  81         if (ref != null && ref.getValue() != null) {
  82             result = getManagingNode(db, ref);
  83         } else {
  84             LOG.warn("Cannot find client for PhysicalSwitch without a specified ManagedBy {}", pNode);
  85             return Optional.absent();
  86         }
  87         if (!result.isPresent()) {
  88             LOG.warn("Failed to find managing node for PhysicalSwitch {}", pNode);
  89         }
  90         return result;
  91     }
  92
  93     public static Optional<HwvtepGlobalAugmentation> getManagingNode(DataBroker db, HwvtepGlobalRef ref) {
  94         try {
  95             ReadOnlyTransaction transaction = db.newReadOnlyTransaction();
  96             @SuppressWarnings("unchecked")
  97             // Note: erasure makes this safe in combination with the typecheck
  98             // below
  99             InstanceIdentifier<Node> path = (InstanceIdentifier<Node>) ref.getValue();
 100
 101             CheckedFuture<Optional<Node>, ReadFailedException> nf =
 102                             transaction.read(LogicalDatastoreType.OPERATIONAL, path);
 103             transaction.close();
 104             Optional<Node> optional = nf.get();
 105             if (optional != null && optional.isPresent()) {
 106                 HwvtepGlobalAugmentation hwvtepNode = null;
 107                 Node node = optional.get();
 108                 if (node instanceof HwvtepGlobalAugmentation) {
 109                     hwvtepNode = (HwvtepGlobalAugmentation) node;
 110                 } else if (node != null) {
 111                     hwvtepNode = node.getAugmentation(HwvtepGlobalAugmentation.class);
 112                 }
 113                 if (hwvtepNode != null) {
 114                     return Optional.of(hwvtepNode);
 115                 } else {
 116                     LOG.warn("Hwvtep switch claims to be managed by {} but " + "that HwvtepNode does not exist",
 117                                     ref.getValue());
 118                     return Optional.absent();
 119                 }
 120             } else {
 121                 LOG.warn("Mysteriously got back a thing which is *not* a topology Node: {}", optional);
 122                 return Optional.absent();
 123             }
 124         } catch (Exception e) {
 125             LOG.warn("Failed to get HwvtepNode {}", ref, e);
 126             return Optional.absent();
 127         }
 128     }
 129     public static String connectionInfoToString(final ConnectionInfo connectionInfo) {
 130         return String.valueOf(
 131                 connectionInfo.getRemoteIp().getValue()) + ":" + connectionInfo.getRemotePort().getValue();
 132     }
 133
 134
 135     public static void schemaMismatchLog(String column, String table, SchemaVersionMismatchException ex) {
 136         LOG.debug(SCHEMA_VERSION_MISMATCH, column, table, "hw_vtep", ex.getMessage());
 137     }
 138 }