netconf/sal-netconf-connector/src/main/java/org/opendaylight/controller/config/yang/md/sal/connector/netconf/NetconfConnectorModule.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.config.yang.md.sal.connector.netconf;
   9
  10 import static org.opendaylight.controller.config.api.JmxAttributeValidationException.checkCondition;
  11 import static org.opendaylight.controller.config.api.JmxAttributeValidationException.checkNotNull;
  12
  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;
  45
  46 /**
  47  * Instead of using loopback (controller-config mount point) to create your netconf-connector,
  48  * you should use the network-topology capability.
  49  *
  50  * <p>
  51  * Follow instructions provided in this
  52  * <a href="https://wiki.opendaylight.org/view/OpenDaylight_Controller:Config:Examples:Netconf#Spawning_netconf_connectors_via_topology_configuration">wiki</a>.
  53  *
  54  * <p>
  55  * Deprecation notice in Carbon, removal planned for Nitrogen.
  56  */
  57 @Deprecated
  58 public final class NetconfConnectorModule
  59         extends org.opendaylight.controller.config.yang.md.sal.connector.netconf.AbstractNetconfConnectorModule
  60         implements BindingAwareConsumer {
  61     private static final Logger LOG = LoggerFactory.getLogger(NetconfConnectorModule.class);
  62
  63     private static final InstanceIdentifier<Topology> TOPOLOGY_PATH = InstanceIdentifier.create(NetworkTopology.class)
  64             .child(Topology.class, new TopologyKey(new TopologyId("topology-netconf")));
  65     private final String instanceName;
  66     private InstanceIdentifier<Node> nodePath;
  67     private DataBroker dataBroker;
  68
  69     public NetconfConnectorModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier,
  70                                   final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver) {
  71         super(identifier, dependencyResolver);
  72         instanceName = identifier.getInstanceName();
  73     }
  74
  75     public NetconfConnectorModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier,
  76                                   final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver,
  77                                   final NetconfConnectorModule oldModule, final java.lang.AutoCloseable oldInstance) {
  78         super(identifier, dependencyResolver, oldModule, oldInstance);
  79         instanceName = identifier.getInstanceName();
  80     }
  81
  82     @Override
  83     protected void customValidation() {
  84         checkNotNull(getAddress(), addressJmxAttribute);
  85         checkCondition(isHostAddressPresent(getAddress()), "Host address not present in " + getAddress(),
  86                 addressJmxAttribute);
  87         checkNotNull(getPort(), portJmxAttribute);
  88
  89         checkNotNull(getConnectionTimeoutMillis(), connectionTimeoutMillisJmxAttribute);
  90         checkCondition(getConnectionTimeoutMillis() > 0, "must be > 0", connectionTimeoutMillisJmxAttribute);
  91
  92         checkNotNull(getDefaultRequestTimeoutMillis(), defaultRequestTimeoutMillisJmxAttribute);
  93         checkCondition(getDefaultRequestTimeoutMillis() > 0, "must be > 0", defaultRequestTimeoutMillisJmxAttribute);
  94
  95         checkNotNull(getBetweenAttemptsTimeoutMillis(), betweenAttemptsTimeoutMillisJmxAttribute);
  96         checkCondition(getBetweenAttemptsTimeoutMillis() > 0, "must be > 0", betweenAttemptsTimeoutMillisJmxAttribute);
  97
  98         // Check username + password in case of ssh
  99         if (!getTcpOnly()) {
 100             checkNotNull(getUsername(), usernameJmxAttribute);
 101             checkNotNull(getPassword(), passwordJmxAttribute);
 102         }
 103     }
 104
 105     private static boolean isHostAddressPresent(final Host address) {
 106         return address.getDomainName() != null || address.getIpAddress() != null
 107                 && (address.getIpAddress().getIpv4Address() != null || address.getIpAddress().getIpv6Address() != null);
 108     }
 109
 110     @Override
 111     public java.lang.AutoCloseable createInstance() {
 112         getBindingRegistryDependency().registerConsumer(this);
 113         return this::deleteNode;
 114     }
 115
 116     @Override
 117     public void onSessionInitialized(final BindingAwareBroker.ConsumerContext session) {
 118         dataBroker = session.getSALService(DataBroker.class);
 119         final WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 120         final NodeId nodeId = new NodeId(instanceName);
 121         final NodeKey nodeKey = new NodeKey(nodeId);
 122         final Node node = createNetconfNode(nodeId, nodeKey);
 123         nodePath = TOPOLOGY_PATH.child(Node.class, nodeKey);
 124         transaction.put(LogicalDatastoreType.CONFIGURATION, nodePath, node);
 125         final CheckedFuture<Void, TransactionCommitFailedException> submitFuture = transaction.submit();
 126         Futures.addCallback(submitFuture, new FutureCallback<Void>() {
 127             @Override
 128             public void onSuccess(@Nullable final Void result) {
 129                 LOG.debug("Node {} was successfully added to the topology", instanceName);
 130             }
 131
 132             @Override
 133             public void onFailure(final Throwable throwable) {
 134                 LOG.error("Node {} creation failed: {}", instanceName, throwable);
 135             }
 136         });
 137     }
 138
 139     private void deleteNode() {
 140         if (dataBroker != null) {
 141             final WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 142             transaction.delete(LogicalDatastoreType.CONFIGURATION, nodePath);
 143             final CheckedFuture<Void, TransactionCommitFailedException> submitFuture = transaction.submit();
 144             Futures.addCallback(submitFuture, new FutureCallback<Void>() {
 145                 @Override
 146                 public void onSuccess(@Nullable final Void result) {
 147                     LOG.debug("Node {} was successfully deleted from the topology", instanceName);
 148                 }
 149
 150                 @Override
 151                 public void onFailure(final Throwable throwable) {
 152                     LOG.error("Node {} deletion failed: {}", instanceName, throwable);
 153                 }
 154             });
 155
 156         }
 157     }
 158
 159     private Node createNetconfNode(final NodeId nodeId, final NodeKey nodeKey) {
 160         final Credentials credentials = new LoginPasswordBuilder()
 161                 .setUsername(getUsername())
 162                 .setPassword(getPassword())
 163                 .build();
 164
 165         YangModuleCapabilities moduleCapabilities = null;
 166         if (getYangModuleCapabilities() != null) {
 167             moduleCapabilities = new YangModuleCapabilitiesBuilder()
 168                     .setOverride(getYangModuleCapabilities().getOverride())
 169                     .setCapability(getYangModuleCapabilities().getCapability())
 170                     .build();
 171         }
 172
 173         NonModuleCapabilities nonModuleCapabilities = null;
 174         if (getNonModuleCapabilities() != null) {
 175             nonModuleCapabilities = new NonModuleCapabilitiesBuilder()
 176                     .setOverride(getNonModuleCapabilities().getOverride())
 177                     .setCapability(getNonModuleCapabilities().getCapability())
 178                     .build();
 179         }
 180
 181         final YangLibrary yangLibrary;
 182         if (getYangLibrary() != null) {
 183             yangLibrary = new YangLibraryBuilder()
 184                     .setYangLibraryUrl(getYangLibrary().getYangLibraryUrl())
 185                     .setUsername(getYangLibrary().getUsername())
 186                     .setPassword(getYangLibrary().getPassword())
 187                     .build();
 188         } else {
 189             yangLibrary = null;
 190         }
 191         final NetconfNode netconfNode = new NetconfNodeBuilder()
 192                 .setHost(getAddress())
 193                 .setPort(getPort())
 194                 .setCredentials(credentials)
 195                 .setConnectionTimeoutMillis(getConnectionTimeoutMillis())
 196                 .setDefaultRequestTimeoutMillis(getDefaultRequestTimeoutMillis())
 197                 .setBetweenAttemptsTimeoutMillis(getBetweenAttemptsTimeoutMillis())
 198                 .setConcurrentRpcLimit(getConcurrentRpcLimit())
 199                 .setKeepaliveDelay(getKeepaliveDelay())
 200                 .setMaxConnectionAttempts(getMaxConnectionAttempts())
 201                 .setReconnectOnChangedSchema(getReconnectOnChangedSchema())
 202                 .setSchemaCacheDirectory(getSchemaCacheDirectory())
 203                 .setSleepFactor(getSleepFactor())
 204                 .setTcpOnly(getTcpOnly())
 205                 .setYangModuleCapabilities(moduleCapabilities)
 206                 .setNonModuleCapabilities(nonModuleCapabilities)
 207                 .setYangLibrary(yangLibrary)
 208                 .build();
 209         return new NodeBuilder()
 210                 .setNodeId(nodeId)
 211                 .setKey(nodeKey)
 212                 .addAugmentation(NetconfNode.class, netconfNode)
 213                 .build();
 214     }
 215 }