BUG-6647 Increase code coverage and clean up II
[bgpcep.git] / 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 java.util.Collection;
16 import java.util.HashMap;
17 import java.util.Iterator;
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 nodeId;
61     }
62
63     public synchronized Metadata getLspMetadata(final String name) {
64         return metadata.get(name);
65     }
66
67     public synchronized void setLspMetadata(final String name, final Metadata value) {
68         if (value == null) {
69             metadata.remove(name);
70         } else {
71             metadata.put(name, value);
72         }
73     }
74
75     public synchronized void cleanupExcept(final Collection<String> values) {
76         final Iterator<String> it = metadata.keySet().iterator();
77         while (it.hasNext()) {
78             if (!values.contains(it.next())) {
79                 it.remove();
80             }
81         }
82     }
83
84     public synchronized void released(final boolean persist) {
85         // The session went down. Undo all the Topology changes we have done.
86         // We might want to persist topology node for later re-use.
87         if (!persist) {
88             final WriteTransaction trans = beginTransaction();
89             trans.delete(LogicalDatastoreType.OPERATIONAL, this.nodeId);
90             Futures.addCallback(trans.submit(), new FutureCallback<Void>() {
91                 @Override
92                 public void onSuccess(final Void result) {
93                     LOG.trace("Internal state for node {} cleaned up successfully", nodeId);
94                 }
95
96                 @Override
97                 public void onFailure(final Throwable t) {
98                     LOG.error("Failed to cleanup internal state for session {}", nodeId, t);
99                 }
100             });
101         }
102
103         lastReleased = System.nanoTime();
104     }
105
106     public synchronized void taken(final boolean retrieveNode) {
107         final long now = System.nanoTime();
108
109         if (now - lastReleased > holdStateNanos) {
110             metadata.clear();
111         }
112
113         //try to get the topology's node
114         if (retrieveNode) {
115             Futures.addCallback(readOperationalData(nodeId), new FutureCallback<Optional<Node>>() {
116
117                 @Override
118                 public void onSuccess(final Optional<Node> result) {
119                     if (!result.isPresent()) {
120                         putTopologyNode();
121                     } else {
122                         //cache retrieved node
123                         initialNodeState = result.get();
124                     }
125                 }
126
127                 @Override
128                 public void onFailure(final Throwable t) {
129                     LOG.error("Failed to get topology node {}", nodeId, t);
130                 }
131             });
132         } else {
133             putTopologyNode();
134         }
135     }
136
137     public synchronized Node getInitialNodeState() {
138         return initialNodeState;
139     }
140
141     WriteTransaction beginTransaction() {
142         return chain.newWriteOnlyTransaction();
143     }
144
145     ReadWriteTransaction rwTransaction() {
146         return chain.newReadWriteTransaction();
147     }
148
149     <T extends DataObject> ListenableFuture<Optional<T>> readOperationalData(final InstanceIdentifier<T> id) {
150         try (final ReadOnlyTransaction t = chain.newReadOnlyTransaction()) {
151             return t.read(LogicalDatastoreType.OPERATIONAL, id);
152         }
153     }
154
155     @Override
156     public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction, final Throwable cause) {
157         // FIXME: flip internal state, so that the next attempt to update fails, triggering node reconnect
158         LOG.error("Unexpected transaction failure in node {} transaction {}", nodeId, transaction.getIdentifier(), cause);
159     }
160
161     @Override
162     public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
163         LOG.info("Node {} shutdown successfully", nodeId);
164     }
165
166     @Override
167     public void close() {
168         chain.close();
169     }
170
171     private void putTopologyNode() {
172         final Node node = new NodeBuilder().setKey(nodeId.getKey()).setNodeId(nodeId.getKey().getNodeId()).build();
173         final WriteTransaction t = beginTransaction();
174         t.put(LogicalDatastoreType.OPERATIONAL, nodeId, node);
175         t.submit();
176     }
177
178 }