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
   9 package org.opendaylight.netconf.topology.singleton.impl;
  10
  11 import akka.actor.ActorRef;
  12 import akka.actor.ActorSystem;
  13 import akka.cluster.Cluster;
  14 import akka.dispatch.OnComplete;
  15 import akka.pattern.Patterns;
  16 import akka.util.Timeout;
  17 import com.google.common.base.Optional;
  18 import com.google.common.base.Preconditions;
  19 import java.util.List;
  20 import java.util.stream.Collectors;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMNotification;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  24 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  25 import org.opendaylight.controller.sal.core.api.Broker;
  26 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  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.NetconfDeviceDataBroker;
  30 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfDeviceNotificationService;
  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.yangtools.yang.common.SimpleDateFormatUtil;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  36 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  37 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40 import scala.concurrent.Future;
  41
  42 class MasterSalFacade implements AutoCloseable, RemoteDeviceHandler<NetconfSessionPreferences> {
  43
  44     private static final Logger LOG = LoggerFactory.getLogger(MasterSalFacade.class);
  45
  46     private final RemoteDeviceId id;
  47     private final Timeout actorResponseWaitTime;
  48
  49     private SchemaContext remoteSchemaContext = null;
  50     private NetconfSessionPreferences netconfSessionPreferences = null;
  51     private DOMRpcService deviceRpc = null;
  52     private final NetconfDeviceSalProvider salProvider;
  53
  54     private final ActorRef masterActorRef;
  55     private final ActorSystem actorSystem;
  56     private DOMDataBroker deviceDataBroker = null;
  57
  58     MasterSalFacade(final RemoteDeviceId id,
  59                     final Broker domBroker,
  60                     final BindingAwareBroker bindingBroker,
  61                     final ActorSystem actorSystem,
  62                     final ActorRef masterActorRef,
  63                     final Timeout actorResponseWaitTime) {
  64         this.id = id;
  65         this.salProvider = new NetconfDeviceSalProvider(id);
  66         this.actorSystem = actorSystem;
  67         this.masterActorRef = masterActorRef;
  68         this.actorResponseWaitTime = actorResponseWaitTime;
  69
  70         registerToSal(domBroker, bindingBroker);
  71     }
  72
  73     private void registerToSal(final Broker domRegistryDependency, final BindingAwareBroker bindingBroker) {
  74         // TODO: remove use of provider, there is possible directly create mount instance and
  75         // TODO: NetconfDeviceTopologyAdapter in constructor = less complexity
  76
  77         domRegistryDependency.registerProvider(salProvider);
  78         bindingBroker.registerProvider(salProvider);
  79     }
  80
  81     @Override
  82     public void onDeviceConnected(final SchemaContext remoteSchemaContext,
  83                                   final NetconfSessionPreferences netconfSessionPreferences,
  84                                   final DOMRpcService deviceRpc) {
  85         this.remoteSchemaContext = remoteSchemaContext;
  86         this.netconfSessionPreferences = netconfSessionPreferences;
  87         this.deviceRpc = deviceRpc;
  88
  89         registerMasterMountPoint();
  90
  91         sendInitialDataToActor().onComplete(new OnComplete<Object>() {
  92             @Override
  93             public void onComplete(final Throwable failure, final Object success) throws Throwable {
  94                 if (failure == null) {
  95                     updateDeviceData();
  96                     return;
  97                 }
  98                 throw failure;
  99             }
 100         }, actorSystem.dispatcher());
 101
 102     }
 103
 104     @Override
 105     public void onDeviceDisconnected() {
 106         salProvider.getTopologyDatastoreAdapter().updateDeviceData(false, new NetconfDeviceCapabilities());
 107         unregisterMasterMountPoint();
 108     }
 109
 110     @Override
 111     public void onDeviceFailed(final Throwable throwable) {
 112         salProvider.getTopologyDatastoreAdapter().setDeviceAsFailed(throwable);
 113         unregisterMasterMountPoint();
 114     }
 115
 116     @Override
 117     public void onNotification(final DOMNotification domNotification) {
 118         salProvider.getMountInstance().publish(domNotification);
 119     }
 120
 121     @Override
 122     public void close() {
 123         unregisterMasterMountPoint();
 124         closeGracefully(salProvider);
 125     }
 126
 127     private void registerMasterMountPoint() {
 128         Preconditions.checkNotNull(id);
 129         Preconditions.checkNotNull(remoteSchemaContext,
 130                 "Device has no remote schema context yet. Probably not fully connected.");
 131         Preconditions.checkNotNull(netconfSessionPreferences,
 132                 "Device has no capabilities yet. Probably not fully connected.");
 133
 134         final NetconfDeviceNotificationService notificationService = new NetconfDeviceNotificationService();
 135
 136         LOG.info("{}: Creating master data broker for device", id);
 137
 138         deviceDataBroker = new NetconfDeviceDataBroker(id, remoteSchemaContext, deviceRpc, netconfSessionPreferences);
 139         // We need to create ProxyDOMDataBroker so accessing mountpoint
 140         // on leader node would be same as on follower node
 141         final ProxyDOMDataBroker proxyDataBroker =
 142                 new ProxyDOMDataBroker(actorSystem, id, masterActorRef, actorResponseWaitTime);
 143         salProvider.getMountInstance()
 144                 .onTopologyDeviceConnected(remoteSchemaContext, proxyDataBroker, deviceRpc, notificationService);
 145     }
 146
 147     private Future<Object> sendInitialDataToActor() {
 148         final List<SourceIdentifier> sourceIdentifiers =
 149                 remoteSchemaContext.getAllModuleIdentifiers().stream().map(mi ->
 150                         RevisionSourceIdentifier.create(mi.getName(),
 151                                 (SimpleDateFormatUtil.DEFAULT_DATE_REV == mi.getRevision() ? Optional.<String>absent() :
 152                                     Optional.of(mi.getQNameModule().getFormattedRevision()))))
 153                         .collect(Collectors.toList());
 154
 155         // send initial data to master actor and create actor for providing it
 156         return Patterns.ask(masterActorRef, new CreateInitialMasterActorData(deviceDataBroker, sourceIdentifiers,
 157                 deviceRpc), actorResponseWaitTime);
 158     }
 159
 160     private void updateDeviceData() {
 161         final Cluster cluster = Cluster.get(actorSystem);
 162         salProvider.getTopologyDatastoreAdapter().updateClusteredDeviceData(true, cluster.selfAddress().toString(),
 163                 netconfSessionPreferences.getNetconfDeviceCapabilities());
 164     }
 165
 166     private void unregisterMasterMountPoint() {
 167         salProvider.getMountInstance().onTopologyDeviceDisconnected();
 168     }
 169
 170     private void closeGracefully(final AutoCloseable resource) {
 171         if (resource != null) {
 172             try {
 173                 resource.close();
 174             } catch (final Exception e) {
 175                 LOG.error("{}: Ignoring exception while closing {}", id, resource, e);
 176             }
 177         }
 178     }
 179
 180 }