2 * Copyright (c) 2016 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.singleton.impl;
10 import static java.util.Objects.requireNonNull;
12 import akka.actor.ActorRef;
13 import akka.actor.ActorSystem;
14 import akka.cluster.Cluster;
15 import akka.dispatch.OnComplete;
16 import akka.pattern.Patterns;
17 import akka.util.Timeout;
18 import java.util.List;
19 import org.opendaylight.mdsal.binding.api.DataBroker;
20 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
21 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
22 import org.opendaylight.mdsal.dom.api.DOMNotification;
23 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
24 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
25 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceId;
26 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceServices;
27 import org.opendaylight.netconf.sal.connect.netconf.NetconfDeviceSchema;
28 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
29 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
30 import org.opendaylight.netconf.sal.connect.netconf.sal.AbstractNetconfDataTreeService;
31 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfDeviceDataBroker;
32 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfDeviceMount;
33 import org.opendaylight.netconf.topology.singleton.messages.CreateInitialMasterActorData;
34 import org.opendaylight.netconf.topology.spi.NetconfDeviceTopologyAdapter;
35 import org.opendaylight.netconf.topology.spi.NetconfNodeUtils;
36 import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext;
37 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
38 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
41 import scala.concurrent.Future;
43 class MasterSalFacade implements RemoteDeviceHandler, AutoCloseable {
44 private static final Logger LOG = LoggerFactory.getLogger(MasterSalFacade.class);
46 private final RemoteDeviceId id;
47 private final Timeout actorResponseWaitTime;
48 private final ActorRef masterActorRef;
49 private final ActorSystem actorSystem;
50 private final NetconfDeviceTopologyAdapter datastoreAdapter;
51 private final NetconfDeviceMount mount;
52 private final boolean lockDatastore;
54 private NetconfDeviceSchema currentSchema = null;
55 private NetconfSessionPreferences netconfSessionPreferences = null;
56 private RemoteDeviceServices deviceServices = null;
57 private DOMDataBroker deviceDataBroker = null;
58 private NetconfDataTreeService netconfService = null;
60 MasterSalFacade(final RemoteDeviceId id,
61 final ActorSystem actorSystem,
62 final ActorRef masterActorRef,
63 final Timeout actorResponseWaitTime,
64 final DOMMountPointService mountService,
65 final DataBroker dataBroker,
66 final boolean lockDatastore) {
68 mount = new NetconfDeviceMount(id, mountService, NetconfNodeUtils.defaultTopologyMountPath(id));
69 this.actorSystem = actorSystem;
70 this.masterActorRef = masterActorRef;
71 this.actorResponseWaitTime = actorResponseWaitTime;
72 this.lockDatastore = lockDatastore;
74 datastoreAdapter = new NetconfDeviceTopologyAdapter(dataBroker, NetconfNodeUtils.DEFAULT_TOPOLOGY_IID, id);
78 public void onDeviceConnected(final NetconfDeviceSchema deviceSchema,
79 final NetconfSessionPreferences sessionPreferences, final RemoteDeviceServices services) {
80 currentSchema = requireNonNull(deviceSchema);
81 netconfSessionPreferences = requireNonNull(sessionPreferences);
82 deviceServices = requireNonNull(services);
83 if (services.actions() != null) {
84 LOG.debug("{}: YANG 1.1 actions are supported in clustered netconf topology, DOMActionService exposed for "
88 LOG.info("Device {} connected - registering master mount point", id);
90 registerMasterMountPoint();
92 sendInitialDataToActor().onComplete(new OnComplete<>() {
94 public void onComplete(final Throwable failure, final Object success) {
95 if (failure == null) {
100 LOG.error("{}: CreateInitialMasterActorData to {} failed", id, masterActorRef, failure);
102 }, actorSystem.dispatcher());
106 public void onDeviceDisconnected() {
107 LOG.info("Device {} disconnected - unregistering master mount point", id);
108 datastoreAdapter.updateDeviceData(false, NetconfDeviceCapabilities.empty(), null);
109 mount.onDeviceDisconnected();
113 public void onDeviceFailed(final Throwable throwable) {
114 datastoreAdapter.setDeviceAsFailed(throwable);
115 mount.onDeviceDisconnected();
119 public void onNotification(final DOMNotification domNotification) {
120 mount.publish(domNotification);
124 public void close() {
125 datastoreAdapter.close();
129 private void registerMasterMountPoint() {
132 final var mountContext = requireNonNull(currentSchema,
133 "Device has no remote schema context yet. Probably not fully connected.")
135 final var preferences = requireNonNull(netconfSessionPreferences,
136 "Device has no capabilities yet. Probably not fully connected.");
138 deviceDataBroker = newDeviceDataBroker(mountContext, preferences);
139 netconfService = newNetconfDataTreeService(mountContext, preferences);
141 // We need to create ProxyDOMDataBroker so accessing mountpoint
142 // on leader node would be same as on follower node
143 final ProxyDOMDataBroker proxyDataBroker = new ProxyDOMDataBroker(id, masterActorRef, actorSystem.dispatcher(),
144 actorResponseWaitTime);
145 final NetconfDataTreeService proxyNetconfService = new ProxyNetconfDataTreeService(id, masterActorRef,
146 actorSystem.dispatcher(), actorResponseWaitTime);
147 mount.onDeviceConnected(mountContext.getEffectiveModelContext(), deviceServices,
148 proxyDataBroker, proxyNetconfService);
151 protected DOMDataBroker newDeviceDataBroker(final MountPointContext mountContext,
152 final NetconfSessionPreferences preferences) {
153 return new NetconfDeviceDataBroker(id, mountContext, deviceServices.rpcs(), preferences, lockDatastore);
156 protected NetconfDataTreeService newNetconfDataTreeService(final MountPointContext mountContext,
157 final NetconfSessionPreferences preferences) {
158 return AbstractNetconfDataTreeService.of(id, mountContext, deviceServices.rpcs(), preferences, lockDatastore);
161 private Future<Object> sendInitialDataToActor() {
162 final List<SourceIdentifier> sourceIdentifiers = List.copyOf(SchemaContextUtil.getConstituentModuleIdentifiers(
163 currentSchema.mountContext().getEffectiveModelContext()));
165 LOG.debug("{}: Sending CreateInitialMasterActorData with sourceIdentifiers {} to {}", id, sourceIdentifiers,
168 // send initial data to master actor
169 return Patterns.ask(masterActorRef, new CreateInitialMasterActorData(deviceDataBroker, netconfService,
170 sourceIdentifiers, deviceServices), actorResponseWaitTime);
173 private void updateDeviceData() {
174 final String masterAddress = Cluster.get(actorSystem).selfAddress().toString();
175 LOG.debug("{}: updateDeviceData with master address {}", id, masterAddress);
176 datastoreAdapter.updateClusteredDeviceData(true, masterAddress, currentSchema.capabilities(),
177 netconfSessionPreferences.sessionId());