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.netconf.util.NetconfTopologyPathCreator;
  33 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 public class TopologyMountPointFacade implements AutoCloseable, RemoteDeviceHandler<NetconfSessionPreferences> {
  38
  39     private static final Logger LOG = LoggerFactory.getLogger(TopologyMountPointFacade.class);
  40
  41     private static final String MOUNT_POINT = "mountpoint";
  42
  43     private final String topologyId;
  44     private final RemoteDeviceId id;
  45     private final Broker domBroker;
  46     private final BindingAwareBroker bindingBroker;
  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         this.topologyId = topologyId;
  63         this.id = id;
  64         this.domBroker = domBroker;
  65         this.bindingBroker = bindingBroker;
  66         this.salProvider = new ClusteredNetconfDeviceMountInstanceProxy(id);
  67         registerToSal(domBroker);
  68     }
  69
  70     public void registerToSal(final Broker domRegistryDependency) {
  71         domRegistryDependency.registerProvider(salProvider);
  72     }
  73
  74     @Override
  75     public void onDeviceConnected(final SchemaContext remoteSchemaContext,
  76                                   final NetconfSessionPreferences netconfSessionPreferences,
  77                                   final DOMRpcService deviceRpc) {
  78         // prepare our prerequisites for mountpoint
  79         LOG.debug("Mount point facade onConnected capabilities {}", netconfSessionPreferences);
  80         this.remoteSchemaContext = remoteSchemaContext;
  81         this.netconfSessionPreferences = netconfSessionPreferences;
  82         this.deviceRpc = deviceRpc;
  83         for (RemoteDeviceHandler<NetconfSessionPreferences> listener : connectionStatusListeners) {
  84             listener.onDeviceConnected(remoteSchemaContext, netconfSessionPreferences, deviceRpc);
  85         }
  86     }
  87
  88     @Override
  89     public void onDeviceDisconnected() {
  90         // do not unregister mount point here, this gets handle by the underlying call from role change callback
  91         for (RemoteDeviceHandler<NetconfSessionPreferences> listener : connectionStatusListeners) {
  92             listener.onDeviceDisconnected();
  93         }
  94     }
  95
  96     @Override
  97     public void onDeviceFailed(Throwable throwable) {
  98         // do not unregister mount point here, this gets handle by the underlying call from role change callback
  99         for (RemoteDeviceHandler<NetconfSessionPreferences> listener : connectionStatusListeners) {
 100             listener.onDeviceFailed(throwable);
 101         }
 102     }
 103
 104     @Override
 105     public void onNotification(DOMNotification domNotification) {
 106         salProvider.getMountInstance().publish(domNotification);
 107     }
 108
 109     public void registerMountPoint(final ActorSystem actorSystem, final ActorContext context) {
 110         if (remoteSchemaContext == null || netconfSessionPreferences == null) {
 111             LOG.debug("Master mount point does not have schemas ready yet, delaying registration");
 112             return;
 113         }
 114
 115         Preconditions.checkNotNull(id);
 116         Preconditions.checkNotNull(remoteSchemaContext, "Device has no remote schema context yet. Probably not fully connected.");
 117         Preconditions.checkNotNull(netconfSessionPreferences, "Device has no capabilities yet. Probably not fully connected.");
 118         this.actorSystem = actorSystem;
 119         final NetconfDeviceNotificationService notificationService = new NetconfDeviceNotificationService();
 120
 121         LOG.warn("Creating master data broker for device {}", id);
 122         deviceDataBroker = TypedActor.get(context).typedActorOf(new TypedProps<>(ProxyNetconfDeviceDataBroker.class, new Creator<NetconfDeviceMasterDataBroker>() {
 123             @Override
 124             public NetconfDeviceMasterDataBroker create() throws Exception {
 125                 return new NetconfDeviceMasterDataBroker(actorSystem, id, remoteSchemaContext, deviceRpc, netconfSessionPreferences);
 126             }
 127         }), MOUNT_POINT);
 128         LOG.debug("Master data broker registered on path {}", TypedActor.get(actorSystem).getActorRefFor(deviceDataBroker).path());
 129         salProvider.getMountInstance().onTopologyDeviceConnected(remoteSchemaContext, deviceDataBroker, deviceRpc, notificationService);
 130         final Cluster cluster = Cluster.get(actorSystem);
 131         final Iterable<Member> members = cluster.state().getMembers();
 132         final ActorRef deviceDataBrokerRef = TypedActor.get(actorSystem).getActorRefFor(deviceDataBroker);
 133         for (final Member member : members) {
 134             if (!member.address().equals(cluster.selfAddress())) {
 135                 final NetconfTopologyPathCreator pathCreator = new NetconfTopologyPathCreator(member.address().toString(),topologyId);
 136                 final String path = pathCreator.withSuffix(id.getName()).build();
 137                 actorSystem.actorSelection(path).tell(new AnnounceMasterMountPoint(), deviceDataBrokerRef);
 138             }
 139         }
 140     }
 141
 142     public void registerMountPoint(final ActorSystem actorSystem, final ActorContext context, final ActorRef masterRef) {
 143         if (remoteSchemaContext == null || netconfSessionPreferences == null) {
 144             LOG.debug("Slave mount point does not have schemas ready yet, delaying registration");
 145             return;
 146         }
 147
 148         Preconditions.checkNotNull(id);
 149         Preconditions.checkNotNull(remoteSchemaContext, "Device has no remote schema context yet. Probably not fully connected.");
 150         Preconditions.checkNotNull(netconfSessionPreferences, "Device has no capabilities yet. Probably not fully connected.");
 151         this.actorSystem = actorSystem;
 152         final NetconfDeviceNotificationService notificationService = new NetconfDeviceNotificationService();
 153
 154         final ProxyNetconfDeviceDataBroker masterDataBroker = TypedActor.get(actorSystem).typedActorOf(new TypedProps<>(ProxyNetconfDeviceDataBroker.class, NetconfDeviceMasterDataBroker.class), masterRef);
 155         LOG.warn("Creating slave data broker for device {}", id);
 156         final DOMDataBroker deviceDataBroker = new NetconfDeviceSlaveDataBroker(actorSystem, id, masterDataBroker);
 157         salProvider.getMountInstance().onTopologyDeviceConnected(remoteSchemaContext, deviceDataBroker, deviceRpc, notificationService);
 158     }
 159
 160     public void unregisterMountPoint() {
 161         salProvider.getMountInstance().onTopologyDeviceDisconnected();
 162         if (deviceDataBroker != null) {
 163             LOG.debug("Stopping master data broker for device {}", id.getName());
 164             for (final Member member : Cluster.get(actorSystem).state().getMembers()) {
 165                 if (member.address().equals(Cluster.get(actorSystem).selfAddress())) {
 166                     continue;
 167                 }
 168                 final NetconfTopologyPathCreator pathCreator = new NetconfTopologyPathCreator(member.address().toString(), topologyId);
 169                 final String path = pathCreator.withSuffix(id.getName()).build();
 170                 actorSystem.actorSelection(path).tell(new AnnounceMasterMountPointDown(), null);
 171             }
 172             TypedActor.get(actorSystem).stop(deviceDataBroker);
 173             deviceDataBroker = null;
 174         }
 175     }
 176
 177     public ConnectionStatusListenerRegistration registerConnectionStatusListener(final RemoteDeviceHandler<NetconfSessionPreferences> listener) {
 178         connectionStatusListeners.add(listener);
 179         return new ConnectionStatusListenerRegistration(listener);
 180     }
 181
 182     @Override
 183     public void close() {
 184         closeGracefully(salProvider);
 185     }
 186
 187     private void closeGracefully(final AutoCloseable resource) {
 188         if (resource != null) {
 189             try {
 190                 resource.close();
 191             } catch (final Exception e) {
 192                 LOG.warn("{}: Ignoring exception while closing {}", id, resource, e);
 193             }
 194         }
 195     }
 196
 197     public class ConnectionStatusListenerRegistration{
 198
 199         private final RemoteDeviceHandler<NetconfSessionPreferences> listener;
 200
 201         public ConnectionStatusListenerRegistration(final RemoteDeviceHandler<NetconfSessionPreferences> listener) {
 202             this.listener = listener;
 203         }
 204
 205         public void close() {
 206             connectionStatusListeners.remove(listener);
 207         }
 208     }
 209 }