netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/impl/MasterSalFacade.java

   1 /*
   2  * Copyright (c) 2016 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.netconf.topology.singleton.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  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.RemoteDeviceServices;
  26 import org.opendaylight.netconf.sal.connect.netconf.NetconfDeviceSchema;
  27 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  28 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  29 import org.opendaylight.netconf.sal.connect.netconf.sal.AbstractNetconfDataTreeService;
  30 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfDeviceDataBroker;
  31 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfDeviceSalProvider;
  32 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  33 import org.opendaylight.netconf.topology.singleton.messages.CreateInitialMasterActorData;
  34 import org.opendaylight.netconf.topology.spi.NetconfDeviceTopologyAdapter;
  35 import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext;
  36 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  37 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40 import scala.concurrent.Future;
  41
  42 class MasterSalFacade implements RemoteDeviceHandler, AutoCloseable {
  43     private static final Logger LOG = LoggerFactory.getLogger(MasterSalFacade.class);
  44
  45     private final RemoteDeviceId id;
  46     private final Timeout actorResponseWaitTime;
  47     private final NetconfDeviceSalProvider salProvider;
  48     private final ActorRef masterActorRef;
  49     private final ActorSystem actorSystem;
  50     private final NetconfDeviceTopologyAdapter datastoreAdapter;
  51     private final boolean lockDatastore;
  52
  53     private NetconfDeviceSchema currentSchema = null;
  54     private NetconfSessionPreferences netconfSessionPreferences = null;
  55     private RemoteDeviceServices deviceServices = null;
  56     private DOMDataBroker deviceDataBroker = null;
  57     private NetconfDataTreeService netconfService = null;
  58
  59     MasterSalFacade(final RemoteDeviceId id,
  60                     final ActorSystem actorSystem,
  61                     final ActorRef masterActorRef,
  62                     final Timeout actorResponseWaitTime,
  63                     final DOMMountPointService mountService,
  64                     final DataBroker dataBroker,
  65                     final boolean lockDatastore) {
  66         this.id = id;
  67         salProvider = new NetconfDeviceSalProvider(id, mountService);
  68         this.actorSystem = actorSystem;
  69         this.masterActorRef = masterActorRef;
  70         this.actorResponseWaitTime = actorResponseWaitTime;
  71         this.lockDatastore = lockDatastore;
  72
  73         datastoreAdapter = new NetconfDeviceTopologyAdapter(dataBroker, id);
  74     }
  75
  76     @Override
  77     public void onDeviceConnected(final NetconfDeviceSchema deviceSchema,
  78             final NetconfSessionPreferences sessionPreferences, final RemoteDeviceServices services) {
  79         currentSchema = requireNonNull(deviceSchema);
  80         netconfSessionPreferences = requireNonNull(sessionPreferences);
  81         deviceServices = requireNonNull(services);
  82         if (services.actions() != null) {
  83             LOG.debug("{}: YANG 1.1 actions are supported in clustered netconf topology, DOMActionService exposed for "
  84                 + "the device", id);
  85         }
  86
  87         LOG.info("Device {} connected - registering master mount point", id);
  88
  89         registerMasterMountPoint();
  90
  91         sendInitialDataToActor().onComplete(new OnComplete<>() {
  92             @Override
  93             public void onComplete(final Throwable failure, final Object success) {
  94                 if (failure == null) {
  95                     updateDeviceData();
  96                     return;
  97                 }
  98
  99                 LOG.error("{}: CreateInitialMasterActorData to {} failed", id, masterActorRef, failure);
 100             }
 101         }, actorSystem.dispatcher());
 102     }
 103
 104     @Override
 105     public void onDeviceDisconnected() {
 106         LOG.info("Device {} disconnected - unregistering master mount point", id);
 107         datastoreAdapter.updateDeviceData(false, NetconfDeviceCapabilities.empty());
 108         unregisterMasterMountPoint();
 109     }
 110
 111     @Override
 112     public void onDeviceFailed(final Throwable throwable) {
 113         datastoreAdapter.setDeviceAsFailed(throwable);
 114         unregisterMasterMountPoint();
 115     }
 116
 117     @Override
 118     public void onNotification(final DOMNotification domNotification) {
 119         salProvider.getMountInstance().publish(domNotification);
 120     }
 121
 122     @Override
 123     public void close() {
 124         datastoreAdapter.close();
 125         unregisterMasterMountPoint();
 126         closeGracefully(salProvider);
 127     }
 128
 129     private void registerMasterMountPoint() {
 130         requireNonNull(id);
 131
 132         final var mountContext = requireNonNull(currentSchema,
 133             "Device has no remote schema context yet. Probably not fully connected.")
 134             .mountContext();
 135         final var preferences = requireNonNull(netconfSessionPreferences,
 136             "Device has no capabilities yet. Probably not fully connected.");
 137
 138         deviceDataBroker = newDeviceDataBroker(mountContext, preferences);
 139         netconfService = newNetconfDataTreeService(mountContext, preferences);
 140
 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         salProvider.getMountInstance().onTopologyDeviceConnected(mountContext.getEffectiveModelContext(),
 148             deviceServices, proxyDataBroker, proxyNetconfService);
 149     }
 150
 151     protected DOMDataBroker newDeviceDataBroker(final MountPointContext mountContext,
 152             final NetconfSessionPreferences preferences) {
 153         return new NetconfDeviceDataBroker(id, mountContext, deviceServices.rpcs(), preferences, lockDatastore);
 154     }
 155
 156     protected NetconfDataTreeService newNetconfDataTreeService(final MountPointContext mountContext,
 157             final NetconfSessionPreferences preferences) {
 158         return AbstractNetconfDataTreeService.of(id, mountContext, deviceServices.rpcs(), preferences, lockDatastore);
 159     }
 160
 161     private Future<Object> sendInitialDataToActor() {
 162         final List<SourceIdentifier> sourceIdentifiers = List.copyOf(SchemaContextUtil.getConstituentModuleIdentifiers(
 163             currentSchema.mountContext().getEffectiveModelContext()));
 164
 165         LOG.debug("{}: Sending CreateInitialMasterActorData with sourceIdentifiers {} to {}", id, sourceIdentifiers,
 166             masterActorRef);
 167
 168         // send initial data to master actor
 169         return Patterns.ask(masterActorRef, new CreateInitialMasterActorData(deviceDataBroker, netconfService,
 170             sourceIdentifiers, deviceServices), actorResponseWaitTime);
 171     }
 172
 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     }
 178
 179     private void unregisterMasterMountPoint() {
 180         salProvider.getMountInstance().onTopologyDeviceDisconnected();
 181     }
 182
 183     @SuppressWarnings("checkstyle:IllegalCatch")
 184     private void closeGracefully(final AutoCloseable resource) {
 185         if (resource != null) {
 186             try {
 187                 resource.close();
 188             } catch (final Exception e) {
 189                 LOG.error("{}: Ignoring exception while closing {}", id, resource, e);
 190             }
 191         }
 192     }
 193 }