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.Preconditions;
12 import com.google.common.util.concurrent.CheckedFuture;
13 import com.google.common.util.concurrent.FutureCallback;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.MoreExecutors;
16 import java.util.ArrayList;
17 import java.util.List;
19 import java.util.concurrent.ExecutionException;
20 import java.util.stream.Collectors;
21 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
22 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
24 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
25 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
26 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus.ConnectionStatus;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilitiesBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.ClusteredConnectionStatusBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilities;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilitiesBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability.FailureReason;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapabilityBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopologyBuilder;
41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
50 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
51 import org.opendaylight.yangtools.yang.common.QName;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
55 public final class NetconfDeviceTopologyAdapter implements AutoCloseable {
57 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceTopologyAdapter.class);
59 private final RemoteDeviceId id;
60 private BindingTransactionChain txChain;
62 private final InstanceIdentifier<NetworkTopology> networkTopologyPath;
63 private final KeyedInstanceIdentifier<Topology, TopologyKey> topologyListPath;
64 private static final String UNKNOWN_REASON = "Unknown reason";
66 NetconfDeviceTopologyAdapter(final RemoteDeviceId id, final BindingTransactionChain txChain) {
68 this.txChain = Preconditions.checkNotNull(txChain);
70 this.networkTopologyPath = InstanceIdentifier.builder(NetworkTopology.class).build();
71 this.topologyListPath = networkTopologyPath
72 .child(Topology.class, new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
77 private void initDeviceData() {
78 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
80 createNetworkTopologyIfNotPresent(writeTx);
82 final InstanceIdentifier<Node> path = id.getTopologyBindingPath();
83 final NodeBuilder nodeBuilder = getNodeIdBuilder(id);
84 NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
85 netconfNodeBuilder.setConnectionStatus(ConnectionStatus.Connecting);
86 netconfNodeBuilder.setHost(id.getHost());
87 netconfNodeBuilder.setPort(new PortNumber(id.getAddress().getPort()));
88 nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
89 Node node = nodeBuilder.build();
91 LOG.trace("{}: Init device state transaction {} putting if absent operational data started.",
92 id, writeTx.getIdentifier());
93 writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
94 LOG.trace("{}: Init device state transaction {} putting operational data ended.", id, writeTx.getIdentifier());
95 LOG.trace("{}: Init device state transaction {} putting if absent config data started.",
96 id, writeTx.getIdentifier());
97 LOG.trace("{}: Init device state transaction {} putting config data ended.", id, writeTx.getIdentifier());
99 commitTransaction(writeTx, "init");
102 public void updateDeviceData(final boolean up, final NetconfDeviceCapabilities capabilities) {
103 final NetconfNode data = buildDataForNetconfNode(up, capabilities);
105 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
106 LOG.trace("{}: Update device state transaction {} merging operational data started.",
107 id, writeTx.getIdentifier());
108 writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class),
110 LOG.trace("{}: Update device state transaction {} merging operational data ended.",
111 id, writeTx.getIdentifier());
113 commitTransaction(writeTx, "update");
116 public void updateClusteredDeviceData(final boolean up, final String masterAddress,
117 final NetconfDeviceCapabilities capabilities) {
118 final NetconfNode data = buildDataForNetconfClusteredNode(up, masterAddress, capabilities);
120 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
121 LOG.trace("{}: Update device state transaction {} merging operational data started.",
122 id, writeTx.getIdentifier());
123 writeTx.put(LogicalDatastoreType.OPERATIONAL,
124 id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
125 LOG.trace("{}: Update device state transaction {} merging operational data ended.",
126 id, writeTx.getIdentifier());
128 commitTransaction(writeTx, "update");
131 public void setDeviceAsFailed(final Throwable throwable) {
132 String reason = throwable != null && throwable.getMessage() != null ? throwable.getMessage() : UNKNOWN_REASON;
134 final NetconfNode data = new NetconfNodeBuilder()
135 .setHost(id.getHost())
136 .setPort(new PortNumber(id.getAddress().getPort()))
137 .setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
139 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
141 "{}: Setting device state as failed {} putting operational data started.",
142 id, writeTx.getIdentifier());
143 writeTx.put(LogicalDatastoreType.OPERATIONAL,
144 id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
146 "{}: Setting device state as failed {} putting operational data ended.",
147 id, writeTx.getIdentifier());
149 commitTransaction(writeTx, "update-failed-device");
152 private NetconfNode buildDataForNetconfNode(final boolean up, final NetconfDeviceCapabilities capabilities) {
153 List<AvailableCapability> capabilityList = new ArrayList<>();
154 capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
155 capabilityList.addAll(capabilities.getResolvedCapabilities());
157 final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
158 avCapabalitiesBuilder.setAvailableCapability(capabilityList);
160 final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
161 .setHost(id.getHost())
162 .setPort(new PortNumber(id.getAddress().getPort()))
163 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
164 .setAvailableCapabilities(avCapabalitiesBuilder.build())
165 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()));
167 return netconfNodeBuilder.build();
170 private NetconfNode buildDataForNetconfClusteredNode(final boolean up, final String masterNodeAddress,
171 final NetconfDeviceCapabilities capabilities) {
172 List<AvailableCapability> capabilityList = new ArrayList<>();
173 capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
174 capabilityList.addAll(capabilities.getResolvedCapabilities());
175 final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
176 avCapabalitiesBuilder.setAvailableCapability(capabilityList);
178 final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
179 .setHost(id.getHost())
180 .setPort(new PortNumber(id.getAddress().getPort()))
181 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
182 .setAvailableCapabilities(avCapabalitiesBuilder.build())
183 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()))
184 .setClusteredConnectionStatus(
185 new ClusteredConnectionStatusBuilder().setNetconfMasterNode(masterNodeAddress).build());
187 return netconfNodeBuilder.build();
190 private static UnavailableCapabilities unavailableCapabilities(final Map<QName, FailureReason> input) {
191 return new UnavailableCapabilitiesBuilder().setUnavailableCapability(input.entrySet().stream().map(
192 e -> new UnavailableCapabilityBuilder().setCapability(e.getKey().toString()).setFailureReason(
193 e.getValue()).build()).collect(Collectors.toList())).build();
196 public void removeDeviceConfiguration() {
197 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
200 "{}: Close device state transaction {} removing all data started.",
201 id, writeTx.getIdentifier());
202 writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
204 "{}: Close device state transaction {} removing all data ended.",
205 id, writeTx.getIdentifier());
208 writeTx.submit().get();
209 } catch (InterruptedException | ExecutionException e) {
210 LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
211 throw new IllegalStateException(id + " Transaction(close) not committed correctly", e);
215 private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
217 final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
218 LOG.trace("{}: Merging {} container to ensure its presence", id,
219 NetworkTopology.QNAME, writeTx.getIdentifier());
220 writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
222 final Topology topology =
223 new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
224 LOG.trace("{}: Merging {} container to ensure its presence", id,
225 Topology.QNAME, writeTx.getIdentifier());
226 writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
229 private void commitTransaction(final WriteTransaction transaction, final String txType) {
230 LOG.trace("{}: Committing Transaction {}:{}", id, txType,
231 transaction.getIdentifier());
232 final CheckedFuture<Void, TransactionCommitFailedException> result = transaction.submit();
234 Futures.addCallback(result, new FutureCallback<Void>() {
236 public void onSuccess(final Void result) {
237 LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType,
238 transaction.getIdentifier());
242 public void onFailure(final Throwable throwable) {
243 LOG.error("{}: Transaction({}) {} FAILED!", id, txType,
244 transaction.getIdentifier(), throwable);
245 throw new IllegalStateException(
246 id + " Transaction(" + txType + ") not committed correctly", throwable);
248 }, MoreExecutors.directExecutor());
251 private static Node getNodeWithId(final RemoteDeviceId id) {
252 final NodeBuilder builder = getNodeIdBuilder(id);
253 return builder.build();
256 private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
257 final NodeBuilder nodeBuilder = new NodeBuilder();
258 nodeBuilder.setKey(new NodeKey(new NodeId(id.getName())));
263 public void close() throws Exception {
264 removeDeviceConfiguration();
267 public void setTxChain(final BindingTransactionChain txChain) {
268 this.txChain = Preconditions.checkNotNull(txChain);