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 private static final Logger LOG = 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 LOG.error("{}: TransactionChain({}) {} FAILED!", id, chain,
89 transaction.getIdentifier(), cause);
90 throw new IllegalStateException(id + " TransactionChain(" + chain + ") not committed correctly", cause);
94 public void onTransactionChainSuccessful(TransactionChain<?, ?> chain) {
95 LOG.trace("{}: TransactionChain({}) SUCCESSFUL", id, chain);
99 this.networkTopologyPath = InstanceIdentifier.builder(NetworkTopology.class).build();
100 this.topologyListPath = networkTopologyPath.child(Topology.class, new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
105 private void initDeviceData() {
106 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
108 createNetworkTopologyIfNotPresent(writeTx);
110 final InstanceIdentifier<Node> path = id.getTopologyBindingPath();
111 NodeBuilder nodeBuilder = getNodeIdBuilder(id);
112 NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
113 netconfNodeBuilder.setConnectionStatus(ConnectionStatus.Connecting);
114 netconfNodeBuilder.setHost(id.getHost());
115 netconfNodeBuilder.setPort(new PortNumber(id.getAddress().getPort()));
116 nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
117 Node node = nodeBuilder.build();
120 "{}: Init device state transaction {} putting if absent operational data started.",
121 id, writeTx.getIdentifier());
122 writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
124 "{}: Init device state transaction {} putting operational data ended.",
125 id, writeTx.getIdentifier());
128 "{}: Init device state transaction {} putting if absent config data started.",
129 id, writeTx.getIdentifier());
130 writeTx.put(LogicalDatastoreType.CONFIGURATION, path, getNodeWithId(id));
132 "{}: Init device state transaction {} putting config data ended.",
133 id, writeTx.getIdentifier());
135 commitTransaction(writeTx, "init");
138 public void updateDeviceData(boolean up, NetconfDeviceCapabilities capabilities) {
139 final Node data = buildDataForNetconfNode(up, capabilities);
141 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
143 "{}: Update device state transaction {} merging operational data started.",
144 id, writeTx.getIdentifier());
145 writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), data);
147 "{}: Update device state transaction {} merging operational data ended.",
148 id, writeTx.getIdentifier());
150 commitTransaction(writeTx, "update");
153 public void setDeviceAsFailed(Throwable throwable) {
154 String reason = (throwable != null && throwable.getMessage() != null) ? throwable.getMessage() : UNKNOWN_REASON;
156 final NetconfNode netconfNode = new NetconfNodeBuilder().setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
157 final Node data = getNodeIdBuilder(id).addAugmentation(NetconfNode.class, netconfNode).build();
159 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
161 "{}: Setting device state as failed {} putting operational data started.",
162 id, writeTx.getIdentifier());
163 writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), data);
165 "{}: Setting device state as failed {} putting operational data ended.",
166 id, writeTx.getIdentifier());
168 commitTransaction(writeTx, "update-failed-device");
171 private Node buildDataForNetconfNode(boolean up, NetconfDeviceCapabilities capabilities) {
172 List<String> capabilityList = new ArrayList<>();
173 capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
174 capabilityList.addAll(FluentIterable.from(capabilities.getResolvedCapabilities()).transform(AVAILABLE_CAPABILITY_TRANSFORMER).toList());
175 final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
176 avCapabalitiesBuilder.setAvailableCapability(capabilityList);
178 final UnavailableCapabilities unavailableCapabilities =
179 new UnavailableCapabilitiesBuilder().setUnavailableCapability(FluentIterable.from(capabilities.getUnresolvedCapabilites().entrySet())
180 .transform(UNAVAILABLE_CAPABILITY_TRANSFORMER).toList()).build();
182 final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
183 .setHost(id.getHost())
184 .setPort(new PortNumber(id.getAddress().getPort()))
185 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
186 .setAvailableCapabilities(avCapabalitiesBuilder.build())
187 .setUnavailableCapabilities(unavailableCapabilities);
189 final NodeBuilder nodeBuilder = getNodeIdBuilder(id);
191 return nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build()).build();
194 public void removeDeviceConfiguration() {
195 final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
198 "{}: Close device state transaction {} removing all data started.",
199 id, writeTx.getIdentifier());
200 writeTx.delete(LogicalDatastoreType.CONFIGURATION, id.getTopologyBindingPath());
201 writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
203 "{}: Close device state transaction {} removing all data ended.",
204 id, writeTx.getIdentifier());
206 commitTransaction(writeTx, "close");
209 private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
211 final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
212 LOG.trace("{}: Merging {} container to ensure its presence", id,
213 networkTopology.QNAME, writeTx.getIdentifier());
214 writeTx.merge(LogicalDatastoreType.CONFIGURATION, networkTopologyPath, networkTopology);
215 writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
217 final Topology topology = new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
218 LOG.trace("{}: Merging {} container to ensure its presence", id,
219 topology.QNAME, writeTx.getIdentifier());
220 writeTx.merge(LogicalDatastoreType.CONFIGURATION, topologyListPath, topology);
221 writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
224 private void commitTransaction(final WriteTransaction transaction, final String txType) {
225 LOG.trace("{}: Committing Transaction {}:{}", id, txType,
226 transaction.getIdentifier());
227 final CheckedFuture<Void, TransactionCommitFailedException> result = transaction.submit();
229 Futures.addCallback(result, new FutureCallback<Void>() {
231 public void onSuccess(final Void result) {
232 LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType,
233 transaction.getIdentifier());
237 public void onFailure(final Throwable t) {
238 LOG.error("{}: Transaction({}) {} FAILED!", id, txType,
239 transaction.getIdentifier(), t);
240 throw new IllegalStateException(id + " Transaction(" + txType + ") not committed correctly", t);
246 private static Node getNodeWithId(final RemoteDeviceId id) {
247 final NodeBuilder builder = getNodeIdBuilder(id);
248 return builder.build();
251 private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
252 final NodeBuilder nodeBuilder = new NodeBuilder();
253 nodeBuilder.setKey(new NodeKey(new NodeId(id.getName())));
258 public void close() throws Exception {
259 removeDeviceConfiguration();