apps/netconf-topology/src/main/java/org/opendaylight/netconf/topology/spi/NetconfTopologyRPCProvider.java

   1 /*
   2  * Copyright (c) 2017 Brocade Communication Systems 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.netconf.topology.spi;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.collect.ImmutableClassToInstanceMap;
  14 import com.google.common.util.concurrent.FutureCallback;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import com.google.common.util.concurrent.SettableFuture;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
  20 import org.opendaylight.mdsal.binding.api.DataBroker;
  21 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  22 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  23 import org.opendaylight.mdsal.common.api.CommitInfo;
  24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev231025.credentials.Credentials;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev231025.credentials.credentials.LoginPw;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev231025.credentials.credentials.LoginPwBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev231025.credentials.credentials.login.pw.LoginPasswordBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.optional.rev221225.NetconfNodeAugmentedOptionalBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.CreateDevice;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.CreateDeviceInput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.CreateDeviceOutput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.CreateDeviceOutputBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.DeleteDevice;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.DeleteDeviceInput;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.DeleteDeviceOutput;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.DeleteDeviceOutputBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNodeBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  48 import org.opendaylight.yangtools.concepts.Registration;
  49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  50 import org.opendaylight.yangtools.yang.binding.Rpc;
  51 import org.opendaylight.yangtools.yang.common.RpcResult;
  52 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 @Deprecated
  57 public final class NetconfTopologyRPCProvider implements AutoCloseable {
  58     private static final Logger LOG = LoggerFactory.getLogger(NetconfTopologyRPCProvider.class);
  59
  60     private final @NonNull InstanceIdentifier<Topology> topologyPath;
  61     private final @NonNull AAAEncryptionService encryptionService;
  62     private final @NonNull DataBroker dataBroker;
  63
  64     private final Registration reg;
  65
  66     public NetconfTopologyRPCProvider(final RpcProviderService rpcProviderService, final DataBroker dataBroker,
  67             final AAAEncryptionService encryptionService, final String topologyId) {
  68         this.dataBroker = requireNonNull(dataBroker);
  69         this.encryptionService = requireNonNull(encryptionService);
  70         topologyPath = InstanceIdentifier.builder(NetworkTopology.class)
  71             .child(Topology.class, new TopologyKey(new TopologyId(topologyId)))
  72             .build();
  73         reg = rpcProviderService.registerRpcImplementations(ImmutableClassToInstanceMap.<Rpc<?, ?>>builder()
  74             .put(CreateDevice.class, this::createDevice)
  75             .put(DeleteDevice.class, this::deleteDevice)
  76             .build());
  77     }
  78
  79     protected @NonNull InstanceIdentifier<Topology> topologyPath() {
  80         return topologyPath;
  81     }
  82
  83     @Override
  84     public void close() {
  85         reg.close();
  86     }
  87
  88     private ListenableFuture<RpcResult<CreateDeviceOutput>> createDevice(final CreateDeviceInput input) {
  89         final var netconfNode = encryptPassword(input);
  90         final var nodeId = new NodeId(input.getNodeId());
  91         final var nodeBuilder = new NodeBuilder()
  92             .setNodeId(nodeId)
  93             .addAugmentation(netconfNode);
  94         if (input.getIgnoreMissingSchemaSources() != null) {
  95             final var netconfNodeOptionalBuilder = new NetconfNodeAugmentedOptionalBuilder(input);
  96             nodeBuilder.addAugmentation(netconfNodeOptionalBuilder.build());
  97         }
  98         final SettableFuture<RpcResult<CreateDeviceOutput>> futureResult = SettableFuture.create();
  99         writeToConfigDS(nodeBuilder.build(), nodeId, futureResult);
 100         return futureResult;
 101     }
 102
 103     private ListenableFuture<RpcResult<DeleteDeviceOutput>> deleteDevice(final DeleteDeviceInput input) {
 104         final NodeId nodeId = new NodeId(input.getNodeId());
 105
 106         final InstanceIdentifier<Node> niid = topologyPath.child(Node.class, new NodeKey(nodeId));
 107
 108         final WriteTransaction wtx = dataBroker.newWriteOnlyTransaction();
 109         wtx.delete(LogicalDatastoreType.CONFIGURATION, niid);
 110
 111         final SettableFuture<RpcResult<DeleteDeviceOutput>> rpcFuture = SettableFuture.create();
 112
 113         wtx.commit().addCallback(new FutureCallback<CommitInfo>() {
 114
 115             @Override
 116             public void onSuccess(final CommitInfo result) {
 117                 LOG.info("delete-device RPC: Removed netconf node successfully.");
 118                 rpcFuture.set(RpcResultBuilder.success(new DeleteDeviceOutputBuilder().build()).build());
 119             }
 120
 121             @Override
 122             public void onFailure(final Throwable exception) {
 123                 LOG.error("delete-device RPC: Unable to remove netconf node.", exception);
 124                 rpcFuture.setException(exception);
 125             }
 126         }, MoreExecutors.directExecutor());
 127
 128         return rpcFuture;
 129     }
 130
 131     @VisibleForTesting
 132     NetconfNode encryptPassword(final CreateDeviceInput input) {
 133         final NetconfNodeBuilder builder = new NetconfNodeBuilder();
 134         builder.fieldsFrom(input);
 135
 136         return builder.setCredentials(handleEncryption(input.getCredentials()))
 137             .build();
 138     }
 139
 140     private Credentials handleEncryption(final Credentials credentials) {
 141         if (credentials instanceof LoginPw loginPw) {
 142             final var loginPassword = loginPw.getLoginPassword();
 143
 144             return new LoginPwBuilder()
 145                 .setLoginPassword(new LoginPasswordBuilder()
 146                     .setUsername(loginPassword.getUsername())
 147                     .setPassword(encryptionService.encrypt(loginPassword.getPassword()))
 148                     .build())
 149                 .build();
 150         }
 151
 152         // nothing else needs to be encrypted
 153         return credentials;
 154     }
 155
 156     private void writeToConfigDS(final Node node, final NodeId nodeId,
 157             final SettableFuture<RpcResult<CreateDeviceOutput>> futureResult) {
 158
 159         final WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 160         final InstanceIdentifier<Node> niid = topologyPath.child(Node.class, new NodeKey(nodeId));
 161         writeTransaction.mergeParentStructureMerge(LogicalDatastoreType.CONFIGURATION, niid, node);
 162         writeTransaction.commit().addCallback(new FutureCallback<CommitInfo>() {
 163
 164             @Override
 165             public void onSuccess(final CommitInfo result) {
 166                 LOG.info("add-netconf-node RPC: Added netconf node successfully.");
 167                 futureResult.set(RpcResultBuilder.success(new CreateDeviceOutputBuilder().build()).build());
 168             }
 169
 170             @Override
 171             public void onFailure(final Throwable exception) {
 172                 LOG.error("add-netconf-node RPC: Unable to add netconf node.", exception);
 173                 futureResult.setException(exception);
 174             }
 175         }, MoreExecutors.directExecutor());
 176     }
 177 }