southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/ovsdb/transact/AutoAttachRemovedCommand.java

   1 /*
   2  * Copyright © 2016, 2017 Inocybe Technologies 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.southbound.ovsdb.transact;
  10
  11 import static org.opendaylight.ovsdb.lib.operations.Operations.op;
  12
  13 import com.google.common.base.Optional;
  14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  15 import java.util.Collection;
  16 import java.util.Collections;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.concurrent.ExecutionException;
  20 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  21 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.ovsdb.lib.notation.Mutator;
  24 import org.opendaylight.ovsdb.lib.notation.UUID;
  25 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
  26 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
  27 import org.opendaylight.ovsdb.schema.openvswitch.AutoAttach;
  28 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
  29 import org.opendaylight.ovsdb.southbound.InstanceIdentifierCodec;
  30 import org.opendaylight.ovsdb.southbound.SouthboundProvider;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.Autoattach;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntry;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 @SuppressFBWarnings("UPM_UNCALLED_PRIVATE_METHOD")
  44 public class AutoAttachRemovedCommand implements TransactCommand {
  45     private static final Logger LOG = LoggerFactory.getLogger(AutoAttachRemovedCommand.class);
  46
  47     @Override
  48     public void execute(TransactionBuilder transaction, BridgeOperationalState state,
  49             Collection<DataTreeModification<Node>> modifications, InstanceIdentifierCodec instanceIdentifierCodec) {
  50         execute(transaction, state, TransactUtils.extractOriginal(modifications, OvsdbNodeAugmentation.class),
  51                 TransactUtils.extractUpdated(modifications, OvsdbNodeAugmentation.class));
  52     }
  53
  54     @Override
  55     public void execute(TransactionBuilder transaction, BridgeOperationalState state,
  56             DataChangeEvent events, InstanceIdentifierCodec instanceIdentifierCodec) {
  57         execute(transaction, state, TransactUtils.extractOriginal(events, OvsdbNodeAugmentation.class),
  58                 TransactUtils.extractUpdated(events, OvsdbNodeAugmentation.class));
  59     }
  60
  61     private void execute(TransactionBuilder transaction, BridgeOperationalState state,
  62                          Map<InstanceIdentifier<OvsdbNodeAugmentation>, OvsdbNodeAugmentation> original,
  63                          Map<InstanceIdentifier<OvsdbNodeAugmentation>, OvsdbNodeAugmentation> updated) {
  64
  65         for (final Map.Entry<InstanceIdentifier<OvsdbNodeAugmentation>, OvsdbNodeAugmentation> originalEntry :
  66                 original.entrySet()) {
  67             final InstanceIdentifier<OvsdbNodeAugmentation> ovsdbNodeIid = originalEntry.getKey();
  68             final OvsdbNodeAugmentation ovsdbNodeAugmentation = originalEntry.getValue();
  69             final OvsdbNodeAugmentation deletedOvsdbNodeAugmentation = updated.get(ovsdbNodeIid);
  70
  71             if (ovsdbNodeAugmentation != null && deletedOvsdbNodeAugmentation != null) {
  72                 final List<Autoattach> origAutoattachList = ovsdbNodeAugmentation.getAutoattach();
  73                 final List<Autoattach> deletedAutoattachList = deletedOvsdbNodeAugmentation.getAutoattach();
  74                 if (origAutoattachList != null && !origAutoattachList.isEmpty()
  75                         && (deletedAutoattachList == null || deletedAutoattachList.isEmpty())) {
  76
  77                     if (true) {
  78                         // FIXME: Remove if loop after ovs community supports external_ids column in AutoAttach Table
  79                         LOG.info("UNSUPPORTED FUNCTIONALITY: Auto Attach related CRUD operations are not supported for"
  80                                 + " this version of OVSDB schema due to missing external_ids column.");
  81                         return;
  82                     }
  83                     final OvsdbNodeAugmentation currentOvsdbNode =
  84                             state.getBridgeNode(ovsdbNodeIid).get().augmentation(OvsdbNodeAugmentation.class);
  85                     final List<Autoattach> currentAutoAttach = currentOvsdbNode.getAutoattach();
  86                     for (final Autoattach origAutoattach : origAutoattachList) {
  87                         final Uri autoAttachId = origAutoattach.getAutoattachId();
  88                         deleteAutoAttach(transaction, ovsdbNodeIid, getAutoAttachUuid(currentAutoAttach, autoAttachId));
  89                     }
  90                 }
  91             }
  92         }
  93     }
  94
  95     private void deleteAutoAttach(TransactionBuilder transaction,
  96             InstanceIdentifier<OvsdbNodeAugmentation> ovsdbNodeIid,
  97             Uuid autoattachUuid) {
  98
  99         LOG.debug("Received request to delete Autoattach entry {}", autoattachUuid);
 100         final OvsdbBridgeAugmentation bridgeAugmentation = getBridge(ovsdbNodeIid, autoattachUuid);
 101         if (autoattachUuid != null && bridgeAugmentation != null) {
 102             final UUID uuid = new UUID(autoattachUuid.getValue());
 103             final AutoAttach autoattach =
 104                     TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), AutoAttach.class, null);
 105             transaction.add(op.delete(autoattach.getSchema())
 106                     .where(autoattach.getUuidColumn().getSchema().opEqual(uuid))
 107                     .build());
 108             transaction.add(op.comment("AutoAttach: Deleting {} " + uuid
 109                     + " attached to " + bridgeAugmentation.getBridgeName().getValue()));
 110
 111             final Bridge bridge = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(),
 112                     Bridge.class,null);
 113
 114             transaction.add(op.mutate(bridge.getSchema())
 115                     .addMutation(bridge.getAutoAttachColumn().getSchema(),
 116                             Mutator.DELETE, Collections.singleton(uuid))
 117                     .where(bridge.getNameColumn().getSchema()
 118                             .opEqual(bridgeAugmentation.getBridgeName().getValue())).build());
 119
 120             transaction.add(op.comment("Bridge: Mutating " + bridgeAugmentation.getBridgeName().getValue()
 121                     + " to remove autoattach column " + uuid));
 122         } else {
 123             LOG.debug("Unable to delete AutoAttach {} for node {} because it was not found in the operational store, "
 124                     + "and thus we cannot retrieve its UUID", autoattachUuid, ovsdbNodeIid);
 125         }
 126     }
 127
 128     private Uuid getAutoAttachUuid(List<Autoattach> currentAutoAttach, Uri autoAttachId) {
 129         if (currentAutoAttach != null && !currentAutoAttach.isEmpty()) {
 130             for (final Autoattach autoAttach : currentAutoAttach) {
 131                 if (autoAttach.getAutoattachId().equals(autoAttachId)) {
 132                     return autoAttach.getAutoattachUuid();
 133                 }
 134             }
 135         }
 136         return null;
 137     }
 138
 139     private OvsdbBridgeAugmentation getBridge(InstanceIdentifier<OvsdbNodeAugmentation> key, Uuid aaUuid) {
 140         if (aaUuid == null) {
 141             return null;
 142         }
 143         OvsdbBridgeAugmentation bridge = null;
 144         final InstanceIdentifier<Node> nodeIid = key.firstIdentifierOf(Node.class);
 145         try (ReadOnlyTransaction transaction = SouthboundProvider.getDb().newReadOnlyTransaction()) {
 146             final Optional<Node> nodeOptional = transaction.read(LogicalDatastoreType.OPERATIONAL, nodeIid).get();
 147             if (nodeOptional.isPresent()) {
 148                 final List<ManagedNodeEntry> managedNodes =
 149                         nodeOptional.get().augmentation(OvsdbNodeAugmentation.class).getManagedNodeEntry();
 150                 for (final ManagedNodeEntry managedNode : managedNodes) {
 151                     final OvsdbBridgeRef ovsdbBridgeRef = managedNode.getBridgeRef();
 152                     final InstanceIdentifier<OvsdbBridgeAugmentation> brIid = ovsdbBridgeRef.getValue()
 153                             .firstIdentifierOf(Node.class).augmentation(OvsdbBridgeAugmentation.class);
 154                     final Optional<OvsdbBridgeAugmentation> optionalBridge =
 155                             transaction.read(LogicalDatastoreType.OPERATIONAL, brIid).get();
 156                     bridge = optionalBridge.orNull();
 157                     if (bridge != null && bridge.getAutoAttach() != null
 158                             && bridge.getAutoAttach().equals(aaUuid)) {
 159                         return bridge;
 160                     }
 161                 }
 162             }
 163         } catch (InterruptedException | ExecutionException e) {
 164             LOG.warn("Error reading from datastore",e);
 165         }
 166         return null;
 167     }
 168 }