2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.netconf.sal.connect.netconf.sal;
11 import com.google.common.base.Function;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.FluentIterable;
14 import com.google.common.util.concurrent.CheckedFuture;
15 import com.google.common.util.concurrent.FutureCallback;
16 import com.google.common.util.concurrent.Futures;
17 import java.util.ArrayList;
18 import java.util.List;
19 import java.util.Map.Entry;
20 import java.util.concurrent.ExecutionException;
21 import java.util.stream.Collectors;
22 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
23 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
25 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
26 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
27 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus.ConnectionStatus;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilitiesBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.ClusteredConnectionStatusBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilities;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilitiesBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability.FailureReason;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapabilityBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopologyBuilder;
43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
49 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
50 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
51 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
52 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
53 import org.opendaylight.yangtools.yang.common.QName;
54 import org.slf4j.Logger;
55 import org.slf4j.LoggerFactory;
57 public final class NetconfDeviceTopologyAdapter implements AutoCloseable {
59 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceTopologyAdapter.class);
60 public static final Function<Entry<QName, FailureReason>, UnavailableCapability> UNAVAILABLE_CAPABILITY_TRANSFORMER = input -> new UnavailableCapabilityBuilder()
61 .setCapability(input.getKey().toString())
62 .setFailureReason(input.getValue()).build();
64 private final RemoteDeviceId id;
65 private BindingTransactionChain txChain;
67 private final InstanceIdentifier<NetworkTopology> networkTopologyPath;
68 private final KeyedInstanceIdentifier<Topology, TopologyKey> topologyListPath;
69 private static final String UNKNOWN_REASON = "Unknown reason";
71 NetconfDeviceTopologyAdapter(final RemoteDeviceId id, final BindingTransactionChain txChain) {
73 this.txChain = Preconditions.checkNotNull(txChain);
75 this.networkTopologyPath = InstanceIdentifier.builder(NetworkTopology.class).build();
76 this.topologyListPath = networkTopologyPath.child(Topology.class, new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
81 private void initDeviceData() {
82 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
84 createNetworkTopologyIfNotPresent(writeTx);
86 final InstanceIdentifier<Node> path = id.getTopologyBindingPath();
87 NodeBuilder nodeBuilder = getNodeIdBuilder(id);
88 NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
89 netconfNodeBuilder.setConnectionStatus(ConnectionStatus.Connecting);
90 netconfNodeBuilder.setHost(id.getHost());
91 netconfNodeBuilder.setPort(new PortNumber(id.getAddress().getPort()));
92 nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
93 Node node = nodeBuilder.build();
96 "{}: Init device state transaction {} putting if absent operational data started.",
97 id, writeTx.getIdentifier());
98 writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
100 "{}: Init device state transaction {} putting operational data ended.",
101 id, writeTx.getIdentifier());
104 "{}: Init device state transaction {} putting if absent config data started.",
105 id, writeTx.getIdentifier());
107 "{}: Init device state transaction {} putting config data ended.",
108 id, writeTx.getIdentifier());
110 commitTransaction(writeTx, "init");
113 public void updateDeviceData(final boolean up, final NetconfDeviceCapabilities capabilities) {
114 final NetconfNode data = buildDataForNetconfNode(up, capabilities);
116 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
118 "{}: Update device state transaction {} merging operational data started.",
119 id, writeTx.getIdentifier());
120 writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
122 "{}: Update device state transaction {} merging operational data ended.",
123 id, writeTx.getIdentifier());
125 commitTransaction(writeTx, "update");
128 public void updateClusteredDeviceData(final boolean up, final String masterAddress, final NetconfDeviceCapabilities capabilities) {
129 final NetconfNode data = buildDataForNetconfClusteredNode(up, masterAddress, capabilities);
131 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
133 "{}: Update device state transaction {} merging operational data started.",
134 id, writeTx.getIdentifier());
135 writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
137 "{}: Update device state transaction {} merging operational data ended.",
138 id, writeTx.getIdentifier());
140 commitTransaction(writeTx, "update");
143 public void setDeviceAsFailed(final Throwable throwable) {
144 String reason = (throwable != null && throwable.getMessage() != null) ? throwable.getMessage() : UNKNOWN_REASON;
146 final NetconfNode data = new NetconfNodeBuilder().setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
148 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
150 "{}: Setting device state as failed {} putting operational data started.",
151 id, writeTx.getIdentifier());
152 writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
154 "{}: Setting device state as failed {} putting operational data ended.",
155 id, writeTx.getIdentifier());
157 commitTransaction(writeTx, "update-failed-device");
160 private NetconfNode buildDataForNetconfNode(final boolean up, final NetconfDeviceCapabilities capabilities) {
161 List<AvailableCapability> capabilityList = new ArrayList<>();
162 capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
163 capabilityList.addAll(capabilities.getResolvedCapabilities());
165 final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
166 avCapabalitiesBuilder.setAvailableCapability(capabilityList);
168 final UnavailableCapabilities unavailableCapabilities =
169 new UnavailableCapabilitiesBuilder().setUnavailableCapability(FluentIterable.from(capabilities.getUnresolvedCapabilites().entrySet())
170 .transform(UNAVAILABLE_CAPABILITY_TRANSFORMER).toList()).build();
172 final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
173 .setHost(id.getHost())
174 .setPort(new PortNumber(id.getAddress().getPort()))
175 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
176 .setAvailableCapabilities(avCapabalitiesBuilder.build())
177 .setUnavailableCapabilities(unavailableCapabilities);
179 return netconfNodeBuilder.build();
182 private NetconfNode buildDataForNetconfClusteredNode(final boolean up, final String masterNodeAddress, final NetconfDeviceCapabilities capabilities) {
183 List<AvailableCapability> capabilityList = new ArrayList<>();
184 capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
185 capabilityList.addAll(capabilities.getResolvedCapabilities());
186 final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
187 avCapabalitiesBuilder.setAvailableCapability(capabilityList);
189 final UnavailableCapabilities unavailableCapabilities =
190 new UnavailableCapabilitiesBuilder().setUnavailableCapability(capabilities.getUnresolvedCapabilites()
191 .entrySet().stream().map(UNAVAILABLE_CAPABILITY_TRANSFORMER::apply)
192 .collect(Collectors.toList())).build();
194 final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
195 .setHost(id.getHost())
196 .setPort(new PortNumber(id.getAddress().getPort()))
197 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
198 .setAvailableCapabilities(avCapabalitiesBuilder.build())
199 .setUnavailableCapabilities(unavailableCapabilities)
200 .setClusteredConnectionStatus(
201 new ClusteredConnectionStatusBuilder().setNetconfMasterNode(masterNodeAddress).build());
203 return netconfNodeBuilder.build();
206 public void removeDeviceConfiguration() {
207 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
210 "{}: Close device state transaction {} removing all data started.",
211 id, writeTx.getIdentifier());
212 writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
214 "{}: Close device state transaction {} removing all data ended.",
215 id, writeTx.getIdentifier());
218 writeTx.submit().get();
219 } catch (InterruptedException | ExecutionException e) {
220 LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
221 throw new IllegalStateException(id + " Transaction(close) not committed correctly", e);
225 private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
227 final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
228 LOG.trace("{}: Merging {} container to ensure its presence", id,
229 NetworkTopology.QNAME, writeTx.getIdentifier());
230 writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
232 final Topology topology = new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
233 LOG.trace("{}: Merging {} container to ensure its presence", id,
234 Topology.QNAME, writeTx.getIdentifier());
235 writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
238 private void commitTransaction(final WriteTransaction transaction, final String txType) {
239 LOG.trace("{}: Committing Transaction {}:{}", id, txType,
240 transaction.getIdentifier());
241 final CheckedFuture<Void, TransactionCommitFailedException> result = transaction.submit();
243 Futures.addCallback(result, new FutureCallback<Void>() {
245 public void onSuccess(final Void result) {
246 LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType,
247 transaction.getIdentifier());
251 public void onFailure(final Throwable t) {
252 LOG.error("{}: Transaction({}) {} FAILED!", id, txType,
253 transaction.getIdentifier(), t);
254 throw new IllegalStateException(id + " Transaction(" + txType + ") not committed correctly", t);
260 private static Node getNodeWithId(final RemoteDeviceId id) {
261 final NodeBuilder builder = getNodeIdBuilder(id);
262 return builder.build();
265 private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
266 final NodeBuilder nodeBuilder = new NodeBuilder();
267 nodeBuilder.setKey(new NodeKey(new NodeId(id.getName())));
272 public void close() throws Exception {
273 removeDeviceConfiguration();
276 public void setTxChain(final BindingTransactionChain txChain) {
277 this.txChain = Preconditions.checkNotNull(txChain);