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 com.google.common.base.Preconditions;
11 import com.google.common.util.concurrent.FutureCallback;
12 import com.google.common.util.concurrent.MoreExecutors;
13 import java.util.ArrayList;
14 import java.util.List;
16 import java.util.concurrent.ExecutionException;
17 import java.util.stream.Collectors;
18 import org.opendaylight.mdsal.binding.api.TransactionChain;
19 import org.opendaylight.mdsal.binding.api.WriteTransaction;
20 import org.opendaylight.mdsal.common.api.CommitInfo;
21 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
22 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
23 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus.ConnectionStatus;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilitiesBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.ClusteredConnectionStatusBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilities;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilitiesBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability.FailureReason;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapabilityBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopologyBuilder;
38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
47 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
48 import org.opendaylight.yangtools.yang.common.QName;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
52 public class NetconfDeviceTopologyAdapter implements AutoCloseable {
54 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceTopologyAdapter.class);
56 private final RemoteDeviceId id;
57 private TransactionChain txChain;
59 private final InstanceIdentifier<NetworkTopology> networkTopologyPath;
60 private final KeyedInstanceIdentifier<Topology, TopologyKey> topologyListPath;
61 private static final String UNKNOWN_REASON = "Unknown reason";
63 NetconfDeviceTopologyAdapter(final RemoteDeviceId id, final TransactionChain txChain) {
65 this.txChain = Preconditions.checkNotNull(txChain);
67 this.networkTopologyPath = InstanceIdentifier.builder(NetworkTopology.class).build();
68 this.topologyListPath = networkTopologyPath
69 .child(Topology.class, new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
74 private void initDeviceData() {
75 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
77 createNetworkTopologyIfNotPresent(writeTx);
79 final InstanceIdentifier<Node> path = id.getTopologyBindingPath();
80 final NodeBuilder nodeBuilder = getNodeIdBuilder(id);
81 NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
82 netconfNodeBuilder.setConnectionStatus(ConnectionStatus.Connecting);
83 netconfNodeBuilder.setHost(id.getHost());
84 netconfNodeBuilder.setPort(new PortNumber(id.getAddress().getPort()));
85 nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
86 Node node = nodeBuilder.build();
88 LOG.trace("{}: Init device state transaction {} putting if absent operational data started.",
89 id, writeTx.getIdentifier());
90 writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
91 LOG.trace("{}: Init device state transaction {} putting operational data ended.", id, writeTx.getIdentifier());
92 LOG.trace("{}: Init device state transaction {} putting if absent config data started.",
93 id, writeTx.getIdentifier());
94 LOG.trace("{}: Init device state transaction {} putting config data ended.", id, writeTx.getIdentifier());
96 commitTransaction(writeTx, "init");
99 public void updateDeviceData(final ConnectionStatus connectionStatus,
100 final NetconfDeviceCapabilities capabilities, final LogicalDatastoreType dsType, final NetconfNode node) {
102 if (node != null && dsType == LogicalDatastoreType.CONFIGURATION) {
105 data = buildDataForNetconfNode(connectionStatus, capabilities, dsType, node);
108 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
109 LOG.trace("{}: Update device state transaction {} merging operational data started.",
110 id, writeTx.getIdentifier());
111 writeTx.put(dsType, id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
112 LOG.trace("{}: Update device state transaction {} merging operational data ended.",
113 id, writeTx.getIdentifier());
115 commitTransaction(writeTx, "update");
118 public void updateDeviceData(final boolean up, final NetconfDeviceCapabilities capabilities) {
119 updateDeviceData(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting, capabilities,
120 LogicalDatastoreType.OPERATIONAL, null);
123 public void updateClusteredDeviceData(final boolean up, final String masterAddress,
124 final NetconfDeviceCapabilities capabilities) {
125 final NetconfNode data = buildDataForNetconfClusteredNode(up, masterAddress, capabilities);
127 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
128 LOG.trace("{}: Update device state transaction {} merging operational data started.",
129 id, writeTx.getIdentifier());
130 writeTx.put(LogicalDatastoreType.OPERATIONAL,
131 id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
132 LOG.trace("{}: Update device state transaction {} merging operational data ended.",
133 id, writeTx.getIdentifier());
135 commitTransaction(writeTx, "update");
138 public void setDeviceAsFailed(final Throwable throwable) {
139 String reason = throwable != null && throwable.getMessage() != null ? throwable.getMessage() : UNKNOWN_REASON;
141 final NetconfNode data = new NetconfNodeBuilder()
142 .setHost(id.getHost())
143 .setPort(new PortNumber(id.getAddress().getPort()))
144 .setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
146 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
148 "{}: Setting device state as failed {} putting operational data started.",
149 id, writeTx.getIdentifier());
150 writeTx.put(LogicalDatastoreType.OPERATIONAL,
151 id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
153 "{}: Setting device state as failed {} putting operational data ended.",
154 id, writeTx.getIdentifier());
156 commitTransaction(writeTx, "update-failed-device");
159 private NetconfNode buildDataForNetconfNode(final ConnectionStatus connectionStatus,
160 final NetconfDeviceCapabilities capabilities, final LogicalDatastoreType dsType, final NetconfNode node) {
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 return new NetconfNodeBuilder()
169 .setHost(id.getHost())
170 .setPort(new PortNumber(id.getAddress().getPort()))
171 .setConnectionStatus(connectionStatus)
172 .setAvailableCapabilities(avCapabalitiesBuilder.build())
173 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()))
177 private NetconfNode buildDataForNetconfClusteredNode(final boolean up, final String masterNodeAddress,
178 final NetconfDeviceCapabilities capabilities) {
179 List<AvailableCapability> capabilityList = new ArrayList<>();
180 capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
181 capabilityList.addAll(capabilities.getResolvedCapabilities());
182 final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
183 avCapabalitiesBuilder.setAvailableCapability(capabilityList);
185 final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
186 .setHost(id.getHost())
187 .setPort(new PortNumber(id.getAddress().getPort()))
188 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
189 .setAvailableCapabilities(avCapabalitiesBuilder.build())
190 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()))
191 .setClusteredConnectionStatus(
192 new ClusteredConnectionStatusBuilder().setNetconfMasterNode(masterNodeAddress).build());
194 return netconfNodeBuilder.build();
197 private static UnavailableCapabilities unavailableCapabilities(final Map<QName, FailureReason> input) {
198 return new UnavailableCapabilitiesBuilder().setUnavailableCapability(input.entrySet().stream().map(
199 e -> new UnavailableCapabilityBuilder().setCapability(e.getKey().toString()).setFailureReason(
200 e.getValue()).build()).collect(Collectors.toList())).build();
203 public void removeDeviceConfiguration() {
204 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
207 "{}: Close device state transaction {} removing all data started.",
208 id, writeTx.getIdentifier());
209 writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
211 "{}: Close device state transaction {} removing all data ended.",
212 id, writeTx.getIdentifier());
215 writeTx.commit().get();
216 } catch (InterruptedException | ExecutionException e) {
217 LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
218 throw new IllegalStateException(id + " Transaction(close) not committed correctly", e);
222 private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
224 final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
225 LOG.trace("{}: Transaction {} merging {} container to ensure its presence", id, writeTx.getIdentifier(),
226 NetworkTopology.QNAME);
227 writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
229 final Topology topology =
230 new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
231 LOG.trace("{}: Transaction {} merging {} container to ensure its presence", id, writeTx.getIdentifier(),
233 writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
236 private void commitTransaction(final WriteTransaction transaction, final String txType) {
237 LOG.trace("{}: Committing Transaction {}:{}", id, txType,
238 transaction.getIdentifier());
240 transaction.commit().addCallback(new FutureCallback<CommitInfo>() {
242 public void onSuccess(final CommitInfo result) {
243 LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType,
244 transaction.getIdentifier());
248 public void onFailure(final Throwable throwable) {
249 LOG.error("{}: Transaction({}) {} FAILED!", id, txType,
250 transaction.getIdentifier(), throwable);
251 throw new IllegalStateException(
252 id + " Transaction(" + txType + ") not committed correctly", throwable);
254 }, MoreExecutors.directExecutor());
257 private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
258 final NodeBuilder nodeBuilder = new NodeBuilder();
259 nodeBuilder.withKey(new NodeKey(new NodeId(id.getName())));
264 public void close() {
265 removeDeviceConfiguration();
268 public void setTxChain(final TransactionChain txChain) {
269 this.txChain = Preconditions.checkNotNull(txChain);