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.YangModuleCapabilities;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.parameters.YangModuleCapabilitiesBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPasswordBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.schema.storage.YangLibrary;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.schema.storage.YangLibraryBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  35 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 /**
  45  *
  46  */
  47 public final class NetconfConnectorModule extends org.opendaylight.controller.config.yang.md.sal.connector.netconf.AbstractNetconfConnectorModule implements BindingAwareConsumer {
  48     private static final Logger LOG = LoggerFactory.getLogger(NetconfConnectorModule.class);
  49
  50     private static final InstanceIdentifier<Topology> TOPOLOGY_PATH = InstanceIdentifier.create(NetworkTopology.class)
  51             .child(Topology.class, new TopologyKey(new TopologyId("topology-netconf")));
  52     private final String instanceName;
  53     private InstanceIdentifier<Node> nodePath;
  54     private DataBroker dataBroker;
  55
  56     public NetconfConnectorModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier, final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver) {
  57         super(identifier, dependencyResolver);
  58         instanceName = identifier.getInstanceName();
  59     }
  60
  61     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) {
  62         super(identifier, dependencyResolver, oldModule, oldInstance);
  63         instanceName = identifier.getInstanceName();
  64     }
  65
  66     @Override
  67     protected void customValidation() {
  68         checkNotNull(getAddress(), addressJmxAttribute);
  69         checkCondition(isHostAddressPresent(getAddress()), "Host address not present in " + getAddress(), addressJmxAttribute);
  70         checkNotNull(getPort(), portJmxAttribute);
  71
  72         checkNotNull(getConnectionTimeoutMillis(), connectionTimeoutMillisJmxAttribute);
  73         checkCondition(getConnectionTimeoutMillis() > 0, "must be > 0", connectionTimeoutMillisJmxAttribute);
  74
  75         checkNotNull(getDefaultRequestTimeoutMillis(), defaultRequestTimeoutMillisJmxAttribute);
  76         checkCondition(getDefaultRequestTimeoutMillis() > 0, "must be > 0", defaultRequestTimeoutMillisJmxAttribute);
  77
  78         checkNotNull(getBetweenAttemptsTimeoutMillis(), betweenAttemptsTimeoutMillisJmxAttribute);
  79         checkCondition(getBetweenAttemptsTimeoutMillis() > 0, "must be > 0", betweenAttemptsTimeoutMillisJmxAttribute);
  80
  81         // Check username + password in case of ssh
  82         if (!getTcpOnly()) {
  83             checkNotNull(getUsername(), usernameJmxAttribute);
  84             checkNotNull(getPassword(), passwordJmxAttribute);
  85         }
  86     }
  87
  88     private boolean isHostAddressPresent(final Host address) {
  89         return address.getDomainName() != null ||
  90                 address.getIpAddress() != null && (address.getIpAddress().getIpv4Address() != null || address.getIpAddress().getIpv6Address() != null);
  91     }
  92
  93     @Override
  94     public java.lang.AutoCloseable createInstance() {
  95         getBindingRegistryDependency().registerConsumer(this);
  96         return this::deleteNode;
  97     }
  98
  99     @Override
 100     public void onSessionInitialized(final BindingAwareBroker.ConsumerContext session) {
 101         dataBroker = session.getSALService(DataBroker.class);
 102         final WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 103         final NodeId nodeId = new NodeId(instanceName);
 104         final NodeKey nodeKey = new NodeKey(nodeId);
 105         final Node node = createNetconfNode(nodeId, nodeKey);
 106         nodePath = TOPOLOGY_PATH.child(Node.class, nodeKey);
 107         transaction.put(LogicalDatastoreType.CONFIGURATION, nodePath, node);
 108         final CheckedFuture<Void, TransactionCommitFailedException> submitFuture = transaction.submit();
 109         Futures.addCallback(submitFuture, new FutureCallback<Void>() {
 110             @Override
 111             public void onSuccess(@Nullable final Void result) {
 112                 LOG.debug("Node {} was successfully added to the topology", instanceName);
 113             }
 114
 115             @Override
 116             public void onFailure(final Throwable t) {
 117                 LOG.error("Node {} creation failed: {}", instanceName, t);
 118             }
 119         });
 120     }
 121
 122     private void deleteNode() {
 123         if (dataBroker != null) {
 124             final WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 125             transaction.delete(LogicalDatastoreType.CONFIGURATION, nodePath);
 126             final CheckedFuture<Void, TransactionCommitFailedException> submitFuture = transaction.submit();
 127             Futures.addCallback(submitFuture, new FutureCallback<Void>() {
 128                 @Override
 129                 public void onSuccess(@Nullable final Void result) {
 130                     LOG.debug("Node {} was successfully deleted from the topology", instanceName);
 131                 }
 132
 133                 @Override
 134                 public void onFailure(final Throwable t) {
 135                     LOG.error("Node {} deletion failed: {}", instanceName, t);
 136                 }
 137             });
 138
 139         }
 140     }
 141
 142     private Node createNetconfNode(final NodeId nodeId, final NodeKey nodeKey) {
 143         final Credentials credentials = new LoginPasswordBuilder()
 144                 .setUsername(getUsername())
 145                 .setPassword(getPassword())
 146                 .build();
 147         final YangModuleCapabilities capabilities;
 148         if (getYangModuleCapabilities() != null) {
 149             capabilities = new YangModuleCapabilitiesBuilder()
 150                     .setOverride(getYangModuleCapabilities().getOverride())
 151                     .setCapability(getYangModuleCapabilities().getCapability())
 152                     .build();
 153         } else {
 154             capabilities = null;
 155         }
 156         final YangLibrary yangLibrary;
 157         if (getYangLibrary() != null) {
 158             yangLibrary = new YangLibraryBuilder()
 159                     .setYangLibraryUrl(getYangLibrary().getYangLibraryUrl())
 160                     .setUsername(getYangLibrary().getUsername())
 161                     .setPassword(getYangLibrary().getPassword())
 162                     .build();
 163         } else {
 164             yangLibrary = null;
 165         }
 166         final NetconfNode netconfNode = new NetconfNodeBuilder()
 167                 .setHost(getAddress())
 168                 .setPort(getPort())
 169                 .setCredentials(credentials)
 170                 .setConnectionTimeoutMillis(getConnectionTimeoutMillis())
 171                 .setDefaultRequestTimeoutMillis(getDefaultRequestTimeoutMillis())
 172                 .setBetweenAttemptsTimeoutMillis(getBetweenAttemptsTimeoutMillis())
 173                 .setConcurrentRpcLimit(getConcurrentRpcLimit())
 174                 .setKeepaliveDelay(getKeepaliveDelay())
 175                 .setMaxConnectionAttempts(getMaxConnectionAttempts())
 176                 .setReconnectOnChangedSchema(getReconnectOnChangedSchema())
 177                 .setSchemaCacheDirectory(getSchemaCacheDirectory())
 178                 .setSleepFactor(getSleepFactor())
 179                 .setTcpOnly(getTcpOnly())
 180                 .setYangModuleCapabilities(capabilities)
 181                 .setYangLibrary(yangLibrary)
 182                 .build();
 183         return new NodeBuilder()
 184                 .setNodeId(nodeId)
 185                 .setKey(nodeKey)
 186                 .addAugmentation(NetconfNode.class, netconfNode)
 187                 .build();
 188     }
 189 }