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.controller.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 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.WriteTransaction;
23 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
25 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
26 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
27 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
28 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfDeviceCapabilities;
29 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeFields.ConnectionStatus;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.AvailableCapabilitiesBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.UnavailableCapabilities;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.UnavailableCapabilitiesBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.unavailable.capabilities.UnavailableCapability;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.unavailable.capabilities.UnavailableCapability.FailureReason;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.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 final class NetconfDeviceTopologyAdapter implements AutoCloseable {
59 public static final Logger logger = LoggerFactory.getLogger(NetconfDeviceTopologyAdapter.class);
60 public static final Function<Entry<QName, FailureReason>, UnavailableCapability> UNAVAILABLE_CAPABILITY_TRANSFORMER = new Function<Entry<QName, FailureReason>, UnavailableCapability>() {
62 public UnavailableCapability apply(final Entry<QName, FailureReason> input) {
63 return new UnavailableCapabilityBuilder()
64 .setCapability(input.getKey().toString())
65 .setFailureReason(input.getValue()).build();
68 public static final Function<QName, String> AVAILABLE_CAPABILITY_TRANSFORMER = new Function<QName, String>() {
70 public String apply(QName qName) {
71 // intern string representation of a capability to avoid duplicates
72 return qName.toString().intern();
76 private final RemoteDeviceId id;
77 private final BindingTransactionChain txChain;
79 private final InstanceIdentifier<NetworkTopology> networkTopologyPath;
80 private final KeyedInstanceIdentifier<Topology, TopologyKey> topologyListPath;
81 private static final String UNKNOWN_REASON = "Unknown reason";
83 NetconfDeviceTopologyAdapter(final RemoteDeviceId id, final DataBroker dataService) {
85 this.txChain = Preconditions.checkNotNull(dataService).createTransactionChain(new TransactionChainListener() {
87 public void onTransactionChainFailed(TransactionChain<?, ?> chain, AsyncTransaction<?, ?> transaction, Throwable cause) {
88 logger.error("{}: TransactionChain({}) {} FAILED!", id, chain, transaction.getIdentifier(), cause);
89 throw new IllegalStateException(id + " TransactionChain(" + chain + ") not committed correctly", cause);
93 public void onTransactionChainSuccessful(TransactionChain<?, ?> chain) {
94 logger.trace("{}: TransactionChain({}) {} SUCCESSFUL", id, chain);
98 this.networkTopologyPath = InstanceIdentifier.builder(NetworkTopology.class).build();
99 this.topologyListPath = networkTopologyPath.child(Topology.class, new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
104 private void initDeviceData() {
105 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
107 createNetworkTopologyIfNotPresent(writeTx);
109 final InstanceIdentifier<Node> path = id.getTopologyBindingPath();
110 NodeBuilder nodeBuilder = getNodeIdBuilder(id);
111 NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
112 netconfNodeBuilder.setConnectionStatus(ConnectionStatus.Connecting);
113 netconfNodeBuilder.setHost(id.getHost());
114 netconfNodeBuilder.setPort(new PortNumber(id.getAddress().getPort()));
115 nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
116 Node node = nodeBuilder.build();
118 logger.trace("{}: Init device state transaction {} putting if absent operational data started.", id, writeTx.getIdentifier());
119 writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
120 logger.trace("{}: Init device state transaction {} putting operational data ended.", id, writeTx.getIdentifier());
122 logger.trace("{}: Init device state transaction {} putting if absent config data started.", id, writeTx.getIdentifier());
123 writeTx.put(LogicalDatastoreType.CONFIGURATION, path, getNodeWithId(id));
124 logger.trace("{}: Init device state transaction {} putting config data ended.", id, writeTx.getIdentifier());
126 commitTransaction(writeTx, "init");
129 public void updateDeviceData(boolean up, NetconfDeviceCapabilities capabilities) {
130 final Node data = buildDataForNetconfNode(up, capabilities);
132 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
133 logger.trace("{}: Update device state transaction {} merging operational data started.", id, writeTx.getIdentifier());
134 writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), data);
135 logger.trace("{}: Update device state transaction {} merging operational data ended.", id, writeTx.getIdentifier());
137 commitTransaction(writeTx, "update");
140 public void setDeviceAsFailed(Throwable throwable) {
141 String reason = (throwable != null && throwable.getMessage() != null) ? throwable.getMessage() : UNKNOWN_REASON;
143 final NetconfNode netconfNode = new NetconfNodeBuilder().setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
144 final Node data = getNodeIdBuilder(id).addAugmentation(NetconfNode.class, netconfNode).build();
146 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
147 logger.trace("{}: Setting device state as failed {} putting operational data started.", id, writeTx.getIdentifier());
148 writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), data);
149 logger.trace("{}: Setting device state as failed {} putting operational data ended.", id, writeTx.getIdentifier());
151 commitTransaction(writeTx, "update-failed-device");
154 private Node buildDataForNetconfNode(boolean up, NetconfDeviceCapabilities capabilities) {
155 List<String> capabilityList = new ArrayList<>();
156 capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
157 capabilityList.addAll(FluentIterable.from(capabilities.getResolvedCapabilities()).transform(AVAILABLE_CAPABILITY_TRANSFORMER).toList());
158 final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
159 avCapabalitiesBuilder.setAvailableCapability(capabilityList);
161 final UnavailableCapabilities unavailableCapabilities =
162 new UnavailableCapabilitiesBuilder().setUnavailableCapability(FluentIterable.from(capabilities.getUnresolvedCapabilites().entrySet())
163 .transform(UNAVAILABLE_CAPABILITY_TRANSFORMER).toList()).build();
165 final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
166 .setHost(id.getHost())
167 .setPort(new PortNumber(id.getAddress().getPort()))
168 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
169 .setAvailableCapabilities(avCapabalitiesBuilder.build())
170 .setUnavailableCapabilities(unavailableCapabilities);
172 final NodeBuilder nodeBuilder = getNodeIdBuilder(id);
174 return nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build()).build();
177 public void removeDeviceConfiguration() {
178 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
180 logger.trace("{}: Close device state transaction {} removing all data started.", id, writeTx.getIdentifier());
181 writeTx.delete(LogicalDatastoreType.CONFIGURATION, id.getTopologyBindingPath());
182 writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
183 logger.trace("{}: Close device state transaction {} removing all data ended.", id, writeTx.getIdentifier());
185 commitTransaction(writeTx, "close");
188 private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
190 final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
191 logger.trace("{}: Merging {} container to ensure its presence", id, networkTopology.QNAME, writeTx.getIdentifier());
192 writeTx.merge(LogicalDatastoreType.CONFIGURATION, networkTopologyPath, networkTopology);
193 writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
195 final Topology topology = new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
196 logger.trace("{}: Merging {} container to ensure its presence", id, topology.QNAME, writeTx.getIdentifier());
197 writeTx.merge(LogicalDatastoreType.CONFIGURATION, topologyListPath, topology);
198 writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
201 private void commitTransaction(final WriteTransaction transaction, final String txType) {
202 logger.trace("{}: Committing Transaction {}:{}", id, txType, transaction.getIdentifier());
203 final CheckedFuture<Void, TransactionCommitFailedException> result = transaction.submit();
205 Futures.addCallback(result, new FutureCallback<Void>() {
207 public void onSuccess(final Void result) {
208 logger.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType, transaction.getIdentifier());
212 public void onFailure(final Throwable t) {
213 logger.error("{}: Transaction({}) {} FAILED!", id, txType, transaction.getIdentifier(), t);
214 throw new IllegalStateException(id + " Transaction(" + txType + ") not committed correctly", t);
220 private static Node getNodeWithId(final RemoteDeviceId id) {
221 final NodeBuilder builder = getNodeIdBuilder(id);
222 return builder.build();
225 private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
226 final NodeBuilder nodeBuilder = new NodeBuilder();
227 nodeBuilder.setKey(new NodeKey(new NodeId(id.getName())));
232 public void close() throws Exception {
233 removeDeviceConfiguration();