opendaylight/netconf/netconf-topology/src/main/java/org/opendaylight/netconf/topology/pipeline/TopologyMountPointFacade.java

   1 /*
   2  * Copyright (c) 2015 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.pipeline;
  10
  11 import akka.actor.ActorContext;
  12 import akka.actor.ActorRef;
  13 import akka.actor.ActorSystem;
  14 import akka.actor.TypedActor;
  15 import akka.actor.TypedProps;
  16 import akka.cluster.Cluster;
  17 import akka.cluster.Member;
  18 import akka.japi.Creator;
  19 import com.google.common.base.Preconditions;
  20 import java.util.ArrayList;
  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.NetconfSessionPreferences;
  28 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfDeviceNotificationService;
  29 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  30 import org.opendaylight.netconf.topology.util.messages.AnnounceMasterMountPoint;
  31 import org.opendaylight.netconf.topology.util.messages.AnnounceMasterMountPointDown;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 public class TopologyMountPointFacade implements AutoCloseable, RemoteDeviceHandler<NetconfSessionPreferences> {
  37
  38     private static final Logger LOG = LoggerFactory.getLogger(TopologyMountPointFacade.class);
  39
  40     private static final String MOUNT_POINT = "mountpoint";
  41
  42     private final String topologyId;
  43     private final RemoteDeviceId id;
  44     private final Broker domBroker;
  45     private final BindingAwareBroker bindingBroker;
  46     private final long defaultRequestTimeoutMillis;
  47
  48     private SchemaContext remoteSchemaContext = null;
  49     private NetconfSessionPreferences netconfSessionPreferences = null;
  50     private DOMRpcService deviceRpc = null;
  51     private final ClusteredNetconfDeviceMountInstanceProxy salProvider;
  52
  53     private ActorSystem actorSystem;
  54     private DOMDataBroker deviceDataBroker = null;
  55
  56     private final ArrayList<RemoteDeviceHandler<NetconfSessionPreferences>> connectionStatusListeners = new ArrayList<>();
  57
  58     public TopologyMountPointFacade(final String topologyId,
  59                                     final RemoteDeviceId id,
  60                                     final Broker domBroker,
  61                                     final BindingAwareBroker bindingBroker,
  62                                     long defaultRequestTimeoutMillis) {
  63         this.topologyId = topologyId;
  64         this.id = id;
  65         this.domBroker = domBroker;
  66         this.bindingBroker = bindingBroker;
  67         this.defaultRequestTimeoutMillis = defaultRequestTimeoutMillis;
  68         this.salProvider = new ClusteredNetconfDeviceMountInstanceProxy(id);
  69         registerToSal(domBroker);
  70     }
  71
  72     public void registerToSal(final Broker domRegistryDependency) {
  73         domRegistryDependency.registerProvider(salProvider);
  74     }
  75
  76     @Override
  77     public void onDeviceConnected(final SchemaContext remoteSchemaContext,
  78                                   final NetconfSessionPreferences netconfSessionPreferences,
  79                                   final DOMRpcService deviceRpc) {
  80         // prepare our prerequisites for mountpoint
  81         this.remoteSchemaContext = remoteSchemaContext;
  82         this.netconfSessionPreferences = netconfSessionPreferences;
  83         this.deviceRpc = deviceRpc;
  84         for (RemoteDeviceHandler<NetconfSessionPreferences> listener : connectionStatusListeners) {
  85             listener.onDeviceConnected(remoteSchemaContext, netconfSessionPreferences, deviceRpc);
  86         }
  87     }
  88
  89     @Override
  90     public void onDeviceDisconnected() {
  91         // do not unregister mount point here, this gets handle by the underlying call from role change callback
  92         for (RemoteDeviceHandler<NetconfSessionPreferences> listener : connectionStatusListeners) {
  93             listener.onDeviceDisconnected();
  94         }
  95     }
  96
  97     @Override
  98     public void onDeviceFailed(Throwable throwable) {
  99         // do not unregister mount point here, this gets handle by the underlying call from role change callback
 100         for (RemoteDeviceHandler<NetconfSessionPreferences> listener : connectionStatusListeners) {
 101             listener.onDeviceFailed(throwable);
 102         }
 103     }
 104
 105     @Override
 106     public void onNotification(DOMNotification domNotification) {
 107         salProvider.getMountInstance().publish(domNotification);
 108     }
 109
 110     public void registerMountPoint(final ActorSystem actorSystem, final ActorContext context) {
 111         Preconditions.checkNotNull(id);
 112         Preconditions.checkNotNull(remoteSchemaContext, "Device has no remote schema context yet. Probably not fully connected.");
 113         Preconditions.checkNotNull(netconfSessionPreferences, "Device has no capabilities yet. Probably not fully connected.");
 114         this.actorSystem = actorSystem;
 115         final NetconfDeviceNotificationService notificationService = new NetconfDeviceNotificationService();
 116
 117         LOG.warn("Creating master data broker for device {}", id);
 118         deviceDataBroker = TypedActor.get(context).typedActorOf(new TypedProps<>(ProxyNetconfDeviceDataBroker.class, new Creator<NetconfDeviceMasterDataBroker>() {
 119             @Override
 120             public NetconfDeviceMasterDataBroker create() throws Exception {
 121                 return new NetconfDeviceMasterDataBroker(actorSystem, id, remoteSchemaContext, deviceRpc, netconfSessionPreferences, defaultRequestTimeoutMillis);
 122             }
 123         }), MOUNT_POINT);
 124         LOG.warn("Master data broker registered on path {}", TypedActor.get(actorSystem).getActorRefFor(deviceDataBroker).path());
 125         salProvider.getMountInstance().onTopologyDeviceConnected(remoteSchemaContext, deviceDataBroker, deviceRpc, notificationService);
 126         final Cluster cluster = Cluster.get(actorSystem);
 127         final Iterable<Member> members = cluster.state().getMembers();
 128         final ActorRef deviceDataBrokerRef = TypedActor.get(actorSystem).getActorRefFor(deviceDataBroker);
 129         for (final Member member : members) {
 130             if (!member.address().equals(cluster.selfAddress())) {
 131                 final String path = member.address() + "/user/" + topologyId + "/" + id.getName();
 132                 actorSystem.actorSelection(path).tell(new AnnounceMasterMountPoint(), deviceDataBrokerRef);
 133             }
 134         }
 135     }
 136
 137     public void registerMountPoint(final ActorSystem actorSystem, final ActorContext context, final ActorRef masterRef) {
 138         Preconditions.checkNotNull(id);
 139         Preconditions.checkNotNull(remoteSchemaContext, "Device has no remote schema context yet. Probably not fully connected.");
 140         Preconditions.checkNotNull(netconfSessionPreferences, "Device has no capabilities yet. Probably not fully connected.");
 141         this.actorSystem = actorSystem;
 142         final NetconfDeviceNotificationService notificationService = new NetconfDeviceNotificationService();
 143
 144         LOG.warn("Creating a proxy for master data broker");
 145         final ProxyNetconfDeviceDataBroker masterDataBroker = TypedActor.get(actorSystem).typedActorOf(new TypedProps<>(ProxyNetconfDeviceDataBroker.class, NetconfDeviceMasterDataBroker.class), masterRef);
 146         LOG.warn("Creating slave data broker for device {}", id);
 147         final DOMDataBroker deviceDataBroker = new NetconfDeviceSlaveDataBroker(actorSystem, id, masterDataBroker);
 148         salProvider.getMountInstance().onTopologyDeviceConnected(remoteSchemaContext, deviceDataBroker, deviceRpc, notificationService);
 149     }
 150
 151     public void unregisterMountPoint() {
 152         salProvider.getMountInstance().onTopologyDeviceDisconnected();
 153         if (deviceDataBroker != null) {
 154             LOG.warn("Stopping master data broker for device {}", id.getName());
 155             for (final Member member : Cluster.get(actorSystem).state().getMembers()) {
 156                 if (member.address().equals(Cluster.get(actorSystem).selfAddress())) {
 157                     continue;
 158                 }
 159                 actorSystem.actorSelection(member.address() + "/user/" + topologyId + "/" + id.getName()).tell(new AnnounceMasterMountPointDown(), null);
 160             }
 161             TypedActor.get(actorSystem).stop(deviceDataBroker);
 162             deviceDataBroker = null;
 163         }
 164     }
 165
 166     public ConnectionStatusListenerRegistration registerConnectionStatusListener(final RemoteDeviceHandler<NetconfSessionPreferences> listener) {
 167         connectionStatusListeners.add(listener);
 168         return new ConnectionStatusListenerRegistration(listener);
 169     }
 170
 171     @Override
 172     public void close() {
 173         closeGracefully(salProvider);
 174     }
 175
 176     private void closeGracefully(final AutoCloseable resource) {
 177         if (resource != null) {
 178             try {
 179                 resource.close();
 180             } catch (final Exception e) {
 181                 LOG.warn("{}: Ignoring exception while closing {}", id, resource, e);
 182             }
 183         }
 184     }
 185
 186     public class ConnectionStatusListenerRegistration{
 187
 188         private final RemoteDeviceHandler<NetconfSessionPreferences> listener;
 189
 190         public ConnectionStatusListenerRegistration(final RemoteDeviceHandler<NetconfSessionPreferences> listener) {
 191             this.listener = listener;
 192         }
 193
 194         public void close() {
 195             connectionStatusListeners.remove(listener);
 196         }
 197     }
 198 }