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
8 package org.opendaylight.netconf.sal.connect.netconf.sal;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.util.concurrent.FutureCallback;
13 import com.google.common.util.concurrent.MoreExecutors;
14 import java.util.ArrayList;
15 import java.util.List;
17 import java.util.concurrent.ExecutionException;
18 import java.util.stream.Collectors;
19 import org.opendaylight.mdsal.binding.api.TransactionChain;
20 import org.opendaylight.mdsal.binding.api.WriteTransaction;
21 import org.opendaylight.mdsal.common.api.CommitInfo;
22 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
23 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
24 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus.ConnectionStatus;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilitiesBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.ClusteredConnectionStatusBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilities;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilitiesBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability.FailureReason;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapabilityBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopologyBuilder;
39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
47 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
48 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
49 import org.opendaylight.yangtools.yang.common.QName;
50 import org.slf4j.Logger;
51 import org.slf4j.LoggerFactory;
53 public class NetconfDeviceTopologyAdapter implements AutoCloseable {
55 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceTopologyAdapter.class);
57 private final RemoteDeviceId id;
58 private TransactionChain txChain;
60 private final InstanceIdentifier<NetworkTopology> networkTopologyPath;
61 private final KeyedInstanceIdentifier<Topology, TopologyKey> topologyListPath;
62 private static final String UNKNOWN_REASON = "Unknown reason";
64 NetconfDeviceTopologyAdapter(final RemoteDeviceId id, final TransactionChain txChain) {
66 this.txChain = requireNonNull(txChain);
68 this.networkTopologyPath = InstanceIdentifier.builder(NetworkTopology.class).build();
69 this.topologyListPath = networkTopologyPath
70 .child(Topology.class, new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
75 private void initDeviceData() {
76 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
78 createNetworkTopologyIfNotPresent(writeTx);
80 final InstanceIdentifier<Node> path = id.getTopologyBindingPath();
81 final NodeBuilder nodeBuilder = getNodeIdBuilder(id);
82 NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
83 netconfNodeBuilder.setConnectionStatus(ConnectionStatus.Connecting);
84 netconfNodeBuilder.setHost(id.getHost());
85 netconfNodeBuilder.setPort(new PortNumber(id.getAddress().getPort()));
86 nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
87 Node node = nodeBuilder.build();
89 LOG.trace("{}: Init device state transaction {} putting if absent operational data started.",
90 id, writeTx.getIdentifier());
91 writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
92 LOG.trace("{}: Init device state transaction {} putting operational data ended.", id, writeTx.getIdentifier());
93 LOG.trace("{}: Init device state transaction {} putting if absent config data started.",
94 id, writeTx.getIdentifier());
95 LOG.trace("{}: Init device state transaction {} putting config data ended.", id, writeTx.getIdentifier());
97 commitTransaction(writeTx, "init");
100 public void updateDeviceData(final ConnectionStatus connectionStatus,
101 final NetconfDeviceCapabilities capabilities, final LogicalDatastoreType dsType, final NetconfNode node) {
103 if (node != null && dsType == LogicalDatastoreType.CONFIGURATION) {
106 data = buildDataForNetconfNode(connectionStatus, capabilities, dsType, node);
109 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
110 LOG.trace("{}: Update device state transaction {} merging operational data started.",
111 id, writeTx.getIdentifier());
112 writeTx.put(dsType, id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
113 LOG.trace("{}: Update device state transaction {} merging operational data ended.",
114 id, writeTx.getIdentifier());
116 commitTransaction(writeTx, "update");
119 public void updateDeviceData(final boolean up, final NetconfDeviceCapabilities capabilities) {
120 updateDeviceData(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting, capabilities,
121 LogicalDatastoreType.OPERATIONAL, null);
124 public void updateClusteredDeviceData(final boolean up, final String masterAddress,
125 final NetconfDeviceCapabilities capabilities) {
126 final NetconfNode data = buildDataForNetconfClusteredNode(up, masterAddress, capabilities);
128 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
129 LOG.trace("{}: Update device state transaction {} merging operational data started.",
130 id, writeTx.getIdentifier());
131 writeTx.put(LogicalDatastoreType.OPERATIONAL,
132 id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
133 LOG.trace("{}: Update device state transaction {} merging operational data ended.",
134 id, writeTx.getIdentifier());
136 commitTransaction(writeTx, "update");
139 public void setDeviceAsFailed(final Throwable throwable) {
140 String reason = throwable != null && throwable.getMessage() != null ? throwable.getMessage() : UNKNOWN_REASON;
142 final NetconfNode data = new NetconfNodeBuilder()
143 .setHost(id.getHost())
144 .setPort(new PortNumber(id.getAddress().getPort()))
145 .setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
147 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
149 "{}: Setting device state as failed {} putting operational data started.",
150 id, writeTx.getIdentifier());
151 writeTx.put(LogicalDatastoreType.OPERATIONAL,
152 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 ConnectionStatus connectionStatus,
161 final NetconfDeviceCapabilities capabilities, final LogicalDatastoreType dsType, final NetconfNode node) {
162 List<AvailableCapability> capabilityList = new ArrayList<>();
163 capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
164 capabilityList.addAll(capabilities.getResolvedCapabilities());
166 final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
167 avCapabalitiesBuilder.setAvailableCapability(capabilityList);
169 return new NetconfNodeBuilder()
170 .setHost(id.getHost())
171 .setPort(new PortNumber(id.getAddress().getPort()))
172 .setConnectionStatus(connectionStatus)
173 .setAvailableCapabilities(avCapabalitiesBuilder.build())
174 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()))
178 private NetconfNode buildDataForNetconfClusteredNode(final boolean up, final String masterNodeAddress,
179 final NetconfDeviceCapabilities capabilities) {
180 List<AvailableCapability> capabilityList = new ArrayList<>();
181 capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
182 capabilityList.addAll(capabilities.getResolvedCapabilities());
183 final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
184 avCapabalitiesBuilder.setAvailableCapability(capabilityList);
186 final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
187 .setHost(id.getHost())
188 .setPort(new PortNumber(id.getAddress().getPort()))
189 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
190 .setAvailableCapabilities(avCapabalitiesBuilder.build())
191 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()))
192 .setClusteredConnectionStatus(
193 new ClusteredConnectionStatusBuilder().setNetconfMasterNode(masterNodeAddress).build());
195 return netconfNodeBuilder.build();
198 private static UnavailableCapabilities unavailableCapabilities(final Map<QName, FailureReason> input) {
199 return new UnavailableCapabilitiesBuilder().setUnavailableCapability(input.entrySet().stream().map(
200 e -> new UnavailableCapabilityBuilder().setCapability(e.getKey().toString()).setFailureReason(
201 e.getValue()).build()).collect(Collectors.toList())).build();
204 public void removeDeviceConfiguration() {
205 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
208 "{}: Close device state transaction {} removing all data started.",
209 id, writeTx.getIdentifier());
210 writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
212 "{}: Close device state transaction {} removing all data ended.",
213 id, writeTx.getIdentifier());
216 writeTx.commit().get();
217 } catch (InterruptedException | ExecutionException e) {
218 LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
219 throw new IllegalStateException(id + " Transaction(close) not committed correctly", e);
223 private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
225 final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
226 LOG.trace("{}: Transaction {} merging {} container to ensure its presence", id, writeTx.getIdentifier(),
227 NetworkTopology.QNAME);
228 writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
230 final Topology topology =
231 new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
232 LOG.trace("{}: Transaction {} merging {} container to ensure its presence", id, writeTx.getIdentifier(),
234 writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
237 private void commitTransaction(final WriteTransaction transaction, final String txType) {
238 LOG.trace("{}: Committing Transaction {}:{}", id, txType,
239 transaction.getIdentifier());
241 transaction.commit().addCallback(new FutureCallback<CommitInfo>() {
243 public void onSuccess(final CommitInfo result) {
244 LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType,
245 transaction.getIdentifier());
249 public void onFailure(final Throwable throwable) {
250 LOG.error("{}: Transaction({}) {} FAILED!", id, txType,
251 transaction.getIdentifier(), throwable);
252 throw new IllegalStateException(
253 id + " Transaction(" + txType + ") not committed correctly", throwable);
255 }, MoreExecutors.directExecutor());
258 private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
259 final NodeBuilder nodeBuilder = new NodeBuilder();
260 nodeBuilder.withKey(new NodeKey(new NodeId(id.getName())));
265 public void close() {
266 removeDeviceConfiguration();
269 public void setTxChain(final TransactionChain txChain) {
270 this.txChain = requireNonNull(txChain);