pcep/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/TopologyNodeState.java

   1 /*
   2  * Copyright (c) 2013 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.bgpcep.pcep.topology.provider;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.MoreExecutors;
  16 import java.util.Collection;
  17 import java.util.HashMap;
  18 import java.util.Map;
  19 import javax.annotation.concurrent.ThreadSafe;
  20 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  22 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  23 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  24 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  25 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  27 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  28 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.lsp.metadata.Metadata;
  30 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  35 import org.opendaylight.yangtools.yang.binding.DataObject;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  37 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40
  41 @ThreadSafe
  42 final class TopologyNodeState implements AutoCloseable, TransactionChainListener {
  43     private static final Logger LOG = LoggerFactory.getLogger(TopologyNodeState.class);
  44     private final Map<String, Metadata> metadata = new HashMap<>();
  45     private final KeyedInstanceIdentifier<Node, NodeKey> nodeId;
  46     private final BindingTransactionChain chain;
  47     private final long holdStateNanos;
  48     private long lastReleased = 0;
  49     //cache initial node state, if any node was persisted
  50     private Node initialNodeState = null;
  51
  52     public TopologyNodeState(final DataBroker broker, final InstanceIdentifier<Topology> topology, final NodeId id, final long holdStateNanos) {
  53         Preconditions.checkArgument(holdStateNanos >= 0);
  54         this.nodeId = topology.child(Node.class, new NodeKey(id));
  55         this.holdStateNanos = holdStateNanos;
  56         this.chain = broker.createTransactionChain(this);
  57     }
  58
  59     public KeyedInstanceIdentifier<Node, NodeKey> getNodeId() {
  60         return this.nodeId;
  61     }
  62
  63     public synchronized Metadata getLspMetadata(final String name) {
  64         return this.metadata.get(name);
  65     }
  66
  67     public synchronized void setLspMetadata(final String name, final Metadata value) {
  68         if (value == null) {
  69             this.metadata.remove(name);
  70         } else {
  71             this.metadata.put(name, value);
  72         }
  73     }
  74
  75     public synchronized void cleanupExcept(final Collection<String> values) {
  76         this.metadata.keySet().removeIf(s -> !values.contains(s));
  77     }
  78
  79     public synchronized void released(final boolean persist) {
  80         // The session went down. Undo all the Topology changes we have done.
  81         // We might want to persist topology node for later re-use.
  82         if (!persist) {
  83             final WriteTransaction trans = beginTransaction();
  84             trans.delete(LogicalDatastoreType.OPERATIONAL, this.nodeId);
  85             Futures.addCallback(trans.submit(), new FutureCallback<Void>() {
  86                 @Override
  87                 public void onSuccess(final Void result) {
  88                     LOG.trace("Internal state for node {} cleaned up successfully", TopologyNodeState.this.nodeId);
  89                 }
  90
  91                 @Override
  92                 public void onFailure(final Throwable t) {
  93                     LOG.error("Failed to cleanup internal state for session {}", TopologyNodeState.this.nodeId, t);
  94                 }
  95             }, MoreExecutors.directExecutor());
  96         }
  97
  98         this.lastReleased = System.nanoTime();
  99     }
 100
 101     public synchronized void taken(final boolean retrieveNode) {
 102         final long now = System.nanoTime();
 103
 104         if (now - this.lastReleased > this.holdStateNanos) {
 105             this.metadata.clear();
 106         }
 107
 108         //try to get the topology's node
 109         if (retrieveNode) {
 110             Futures.addCallback(readOperationalData(this.nodeId), new FutureCallback<Optional<Node>>() {
 111
 112                 @Override
 113                 public void onSuccess(final Optional<Node> result) {
 114                     if (!result.isPresent()) {
 115                         putTopologyNode();
 116                     } else {
 117                         //cache retrieved node
 118                         TopologyNodeState.this.initialNodeState = result.get();
 119                     }
 120                 }
 121
 122                 @Override
 123                 public void onFailure(final Throwable t) {
 124                     LOG.error("Failed to get topology node {}", TopologyNodeState.this.nodeId, t);
 125                 }
 126             }, MoreExecutors.directExecutor());
 127         } else {
 128             putTopologyNode();
 129         }
 130     }
 131
 132     public synchronized Node getInitialNodeState() {
 133         return this.initialNodeState;
 134     }
 135
 136     WriteTransaction beginTransaction() {
 137         return this.chain.newWriteOnlyTransaction();
 138     }
 139
 140     ReadWriteTransaction rwTransaction() {
 141         return this.chain.newReadWriteTransaction();
 142     }
 143
 144     <T extends DataObject> ListenableFuture<Optional<T>> readOperationalData(final InstanceIdentifier<T> id) {
 145         try (final ReadOnlyTransaction t = this.chain.newReadOnlyTransaction()) {
 146             return t.read(LogicalDatastoreType.OPERATIONAL, id);
 147         }
 148     }
 149
 150     @Override
 151     public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 152         // FIXME: flip internal state, so that the next attempt to update fails, triggering node reconnect
 153         LOG.error("Unexpected transaction failure in node {} transaction {}", this.nodeId, transaction.getIdentifier(), cause);
 154     }
 155
 156     @Override
 157     public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 158         LOG.info("Node {} shutdown successfully", this.nodeId);
 159     }
 160
 161     @Override
 162     public void close() {
 163         this.chain.close();
 164     }
 165
 166     private void putTopologyNode() {
 167         final Node node = new NodeBuilder().setKey(this.nodeId.getKey()).setNodeId(this.nodeId.getKey().getNodeId()).build();
 168         final WriteTransaction t = beginTransaction();
 169         t.put(LogicalDatastoreType.OPERATIONAL, this.nodeId, node);
 170         t.submit();
 171     }
 172
 173 }