2 * Copyright (c) 2014 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.controller.config.yang.md.sal.connector.netconf;
10 import static org.opendaylight.controller.config.api.JmxAttributeValidationException.checkCondition;
11 import static org.opendaylight.controller.config.api.JmxAttributeValidationException.checkNotNull;
13 import com.google.common.util.concurrent.CheckedFuture;
14 import com.google.common.util.concurrent.FutureCallback;
15 import com.google.common.util.concurrent.Futures;
16 import javax.annotation.Nullable;
17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
18 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
20 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
21 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
22 import org.opendaylight.controller.sal.binding.api.BindingAwareConsumer;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.parameters.NonModuleCapabilities;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.parameters.NonModuleCapabilitiesBuilder;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.parameters.YangModuleCapabilities;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.parameters.YangModuleCapabilitiesBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPasswordBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.schema.storage.YangLibrary;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.schema.storage.YangLibraryBuilder;
34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
35 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
42 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
47 * Instead of using loopback (controller-config mount point) to create your netconf-connector, you should use the network-topology capability.
49 * Follow instructions provided in this <a href="https://wiki.opendaylight.org/view/OpenDaylight_Controller:Config:Examples:Netconf#Spawning_netconf_connectors_via_topology_configuration">wiki</a>.
51 * Deprecation notice in Carbon, removal planned for Nitrogen.
54 public final class NetconfConnectorModule extends org.opendaylight.controller.config.yang.md.sal.connector.netconf.AbstractNetconfConnectorModule implements BindingAwareConsumer {
55 private static final Logger LOG = LoggerFactory.getLogger(NetconfConnectorModule.class);
57 private static final InstanceIdentifier<Topology> TOPOLOGY_PATH = InstanceIdentifier.create(NetworkTopology.class)
58 .child(Topology.class, new TopologyKey(new TopologyId("topology-netconf")));
59 private final String instanceName;
60 private InstanceIdentifier<Node> nodePath;
61 private DataBroker dataBroker;
63 public NetconfConnectorModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier, final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver) {
64 super(identifier, dependencyResolver);
65 instanceName = identifier.getInstanceName();
68 public NetconfConnectorModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier, final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver, final NetconfConnectorModule oldModule, final java.lang.AutoCloseable oldInstance) {
69 super(identifier, dependencyResolver, oldModule, oldInstance);
70 instanceName = identifier.getInstanceName();
74 protected void customValidation() {
75 checkNotNull(getAddress(), addressJmxAttribute);
76 checkCondition(isHostAddressPresent(getAddress()), "Host address not present in " + getAddress(), addressJmxAttribute);
77 checkNotNull(getPort(), portJmxAttribute);
79 checkNotNull(getConnectionTimeoutMillis(), connectionTimeoutMillisJmxAttribute);
80 checkCondition(getConnectionTimeoutMillis() > 0, "must be > 0", connectionTimeoutMillisJmxAttribute);
82 checkNotNull(getDefaultRequestTimeoutMillis(), defaultRequestTimeoutMillisJmxAttribute);
83 checkCondition(getDefaultRequestTimeoutMillis() > 0, "must be > 0", defaultRequestTimeoutMillisJmxAttribute);
85 checkNotNull(getBetweenAttemptsTimeoutMillis(), betweenAttemptsTimeoutMillisJmxAttribute);
86 checkCondition(getBetweenAttemptsTimeoutMillis() > 0, "must be > 0", betweenAttemptsTimeoutMillisJmxAttribute);
88 // Check username + password in case of ssh
90 checkNotNull(getUsername(), usernameJmxAttribute);
91 checkNotNull(getPassword(), passwordJmxAttribute);
95 private static boolean isHostAddressPresent(final Host address) {
96 return address.getDomainName() != null ||
97 address.getIpAddress() != null && (address.getIpAddress().getIpv4Address() != null || address.getIpAddress().getIpv6Address() != null);
101 public java.lang.AutoCloseable createInstance() {
102 getBindingRegistryDependency().registerConsumer(this);
103 return this::deleteNode;
107 public void onSessionInitialized(final BindingAwareBroker.ConsumerContext session) {
108 dataBroker = session.getSALService(DataBroker.class);
109 final WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
110 final NodeId nodeId = new NodeId(instanceName);
111 final NodeKey nodeKey = new NodeKey(nodeId);
112 final Node node = createNetconfNode(nodeId, nodeKey);
113 nodePath = TOPOLOGY_PATH.child(Node.class, nodeKey);
114 transaction.put(LogicalDatastoreType.CONFIGURATION, nodePath, node);
115 final CheckedFuture<Void, TransactionCommitFailedException> submitFuture = transaction.submit();
116 Futures.addCallback(submitFuture, new FutureCallback<Void>() {
118 public void onSuccess(@Nullable final Void result) {
119 LOG.debug("Node {} was successfully added to the topology", instanceName);
123 public void onFailure(final Throwable t) {
124 LOG.error("Node {} creation failed: {}", instanceName, t);
129 private void deleteNode() {
130 if (dataBroker != null) {
131 final WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
132 transaction.delete(LogicalDatastoreType.CONFIGURATION, nodePath);
133 final CheckedFuture<Void, TransactionCommitFailedException> submitFuture = transaction.submit();
134 Futures.addCallback(submitFuture, new FutureCallback<Void>() {
136 public void onSuccess(@Nullable final Void result) {
137 LOG.debug("Node {} was successfully deleted from the topology", instanceName);
141 public void onFailure(final Throwable t) {
142 LOG.error("Node {} deletion failed: {}", instanceName, t);
149 private Node createNetconfNode(final NodeId nodeId, final NodeKey nodeKey) {
150 final Credentials credentials = new LoginPasswordBuilder()
151 .setUsername(getUsername())
152 .setPassword(getPassword())
155 YangModuleCapabilities moduleCapabilities = null;
156 if (getYangModuleCapabilities() != null) {
157 moduleCapabilities = new YangModuleCapabilitiesBuilder()
158 .setOverride(getYangModuleCapabilities().getOverride())
159 .setCapability(getYangModuleCapabilities().getCapability())
163 NonModuleCapabilities nonModuleCapabilities = null;
164 if(getNonModuleCapabilities() != null) {
165 nonModuleCapabilities = new NonModuleCapabilitiesBuilder()
166 .setOverride(getNonModuleCapabilities().getOverride())
167 .setCapability(getNonModuleCapabilities().getCapability())
171 final YangLibrary yangLibrary;
172 if (getYangLibrary() != null) {
173 yangLibrary = new YangLibraryBuilder()
174 .setYangLibraryUrl(getYangLibrary().getYangLibraryUrl())
175 .setUsername(getYangLibrary().getUsername())
176 .setPassword(getYangLibrary().getPassword())
181 final NetconfNode netconfNode = new NetconfNodeBuilder()
182 .setHost(getAddress())
184 .setCredentials(credentials)
185 .setConnectionTimeoutMillis(getConnectionTimeoutMillis())
186 .setDefaultRequestTimeoutMillis(getDefaultRequestTimeoutMillis())
187 .setBetweenAttemptsTimeoutMillis(getBetweenAttemptsTimeoutMillis())
188 .setConcurrentRpcLimit(getConcurrentRpcLimit())
189 .setKeepaliveDelay(getKeepaliveDelay())
190 .setMaxConnectionAttempts(getMaxConnectionAttempts())
191 .setReconnectOnChangedSchema(getReconnectOnChangedSchema())
192 .setSchemaCacheDirectory(getSchemaCacheDirectory())
193 .setSleepFactor(getSleepFactor())
194 .setTcpOnly(getTcpOnly())
195 .setYangModuleCapabilities(moduleCapabilities)
196 .setNonModuleCapabilities(nonModuleCapabilities)
197 .setYangLibrary(yangLibrary)
199 return new NodeBuilder()
202 .addAugmentation(NetconfNode.class, netconfNode)