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
8 package org.opendaylight.netconf.topology.spi;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.VisibleForTesting;
13 import io.netty.util.concurrent.EventExecutor;
14 import java.util.HashMap;
15 import java.util.concurrent.ExecutionException;
16 import java.util.concurrent.Executor;
17 import java.util.concurrent.ScheduledExecutorService;
18 import org.checkerframework.checker.lock.qual.Holding;
19 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
20 import org.opendaylight.controller.config.threadpool.ThreadPool;
21 import org.opendaylight.mdsal.binding.api.DataBroker;
22 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
23 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
24 import org.opendaylight.netconf.client.NetconfClientDispatcher;
25 import org.opendaylight.netconf.client.mdsal.api.BaseNetconfSchemas;
26 import org.opendaylight.netconf.client.mdsal.api.DeviceActionFactory;
27 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceHandler;
28 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceId;
29 import org.opendaylight.netconf.client.mdsal.api.SchemaResourceManager;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.optional.rev221225.NetconfNodeAugmentedOptional;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
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.TopologyBuilder;
37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
43 public abstract class AbstractNetconfTopology {
44 private static final Logger LOG = LoggerFactory.getLogger(AbstractNetconfTopology.class);
46 private final HashMap<NodeId, NetconfNodeHandler> activeConnectors = new HashMap<>();
47 private final NetconfClientDispatcher clientDispatcher;
48 private final EventExecutor eventExecutor;
49 private final DeviceActionFactory deviceActionFactory;
50 private final SchemaResourceManager schemaManager;
51 private final BaseNetconfSchemas baseSchemas;
52 private final NetconfClientConfigurationBuilderFactory builderFactory;
54 protected final ScheduledExecutorService keepaliveExecutor;
55 protected final Executor processingExecutor;
56 protected final DataBroker dataBroker;
57 protected final DOMMountPointService mountPointService;
58 protected final String topologyId;
60 protected AbstractNetconfTopology(final String topologyId, final NetconfClientDispatcher clientDispatcher,
61 final EventExecutor eventExecutor, final ScheduledThreadPool keepaliveExecutor,
62 final ThreadPool processingExecutor, final SchemaResourceManager schemaManager, final DataBroker dataBroker,
63 final DOMMountPointService mountPointService, final NetconfClientConfigurationBuilderFactory builderFactory,
64 final DeviceActionFactory deviceActionFactory, final BaseNetconfSchemas baseSchemas) {
65 this.topologyId = requireNonNull(topologyId);
66 this.clientDispatcher = clientDispatcher;
67 this.eventExecutor = eventExecutor;
68 this.keepaliveExecutor = keepaliveExecutor.getExecutor();
69 this.processingExecutor = processingExecutor.getExecutor();
70 this.schemaManager = requireNonNull(schemaManager);
71 this.deviceActionFactory = deviceActionFactory;
72 this.dataBroker = requireNonNull(dataBroker);
73 this.mountPointService = mountPointService;
74 this.builderFactory = requireNonNull(builderFactory);
75 this.baseSchemas = requireNonNull(baseSchemas);
77 // FIXME: this should be a put(), as we are initializing and will be re-populating the datastore with all the
78 // devices. Whatever has been there before should be nuked to properly re-align lifecycle.
79 final var wtx = dataBroker.newWriteOnlyTransaction();
80 wtx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.builder(NetworkTopology.class)
81 .child(Topology.class, new TopologyKey(new TopologyId(topologyId)))
82 .build(), new TopologyBuilder().setTopologyId(new TopologyId(topologyId)).build());
83 final var future = wtx.commit();
86 } catch (InterruptedException | ExecutionException e) {
87 LOG.error("Unable to initialize topology {}", topologyId, e);
88 throw new IllegalStateException(e);
91 LOG.debug("Topology {} initialized", topologyId);
94 // Non-final for testing
95 protected void ensureNode(final Node node) {
96 lockedEnsureNode(node);
99 private synchronized void lockedEnsureNode(final Node node) {
100 final var nodeId = node.requireNodeId();
101 final var prev = activeConnectors.remove(nodeId);
103 LOG.info("RemoteDevice{{}} was already configured, disconnecting", nodeId);
107 LOG.info("Connecting RemoteDevice{{}}, with config {}", nodeId, hideCredentials(node));
108 setupConnection(nodeId, node);
111 // Non-final for testing
112 protected void deleteNode(final NodeId nodeId) {
113 lockedDeleteNode(nodeId);
116 private synchronized void lockedDeleteNode(final NodeId nodeId) {
117 final var nodeName = nodeId.getValue();
118 LOG.debug("Disconnecting RemoteDevice{{}}", nodeName);
120 final var connectorDTO = activeConnectors.remove(nodeId);
121 if (connectorDTO != null) {
122 connectorDTO.close();
126 protected final synchronized void deleteAllNodes() {
127 activeConnectors.values().forEach(NetconfNodeHandler::close);
128 activeConnectors.clear();
132 protected final void setupConnection(final NodeId nodeId, final Node configNode) {
133 final var netconfNode = configNode.augmentation(NetconfNode.class);
134 final var nodeOptional = configNode.augmentation(NetconfNodeAugmentedOptional.class);
136 // Instantiate the handler ...
137 final var deviceId = NetconfNodeUtils.toRemoteDeviceId(nodeId, netconfNode);
138 final var deviceSalFacade = createSalFacade(deviceId, netconfNode.requireLockDatastore());
139 final var nodeHandler = new NetconfNodeHandler(clientDispatcher, eventExecutor, keepaliveExecutor,
140 baseSchemas, schemaManager, processingExecutor, builderFactory, deviceActionFactory, deviceSalFacade,
141 deviceId, nodeId, netconfNode, nodeOptional);
144 activeConnectors.put(nodeId, nodeHandler);
147 nodeHandler.connect();
150 protected RemoteDeviceHandler createSalFacade(final RemoteDeviceId deviceId, final boolean lockDatastore) {
151 return new NetconfTopologyDeviceSalFacade(deviceId, mountPointService, lockDatastore, dataBroker);
155 * Hiding of private credentials from node configuration (credentials data is replaced by asterisks).
157 * @param nodeConfiguration Node configuration container.
158 * @return String representation of node configuration with credentials replaced by asterisks.
161 static final String hideCredentials(final Node nodeConfiguration) {
162 final var netconfNodeAugmentation = nodeConfiguration.augmentation(NetconfNode.class);
163 final var nodeCredentials = netconfNodeAugmentation.getCredentials().toString();
164 final var nodeConfigurationString = nodeConfiguration.toString();
165 return nodeConfigurationString.replace(nodeCredentials, "***");