opendaylight/netconf/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/sal/NetconfDeviceSalProvider.java

   1 /*
   2  * Copyright (c) 2014 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.controller.sal.connect.netconf.sal;
   9
  10 import com.google.common.base.Preconditions;
  11 import java.util.Collection;
  12 import java.util.Collections;
  13 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  14 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  15 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  16 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  17 import org.opendaylight.controller.md.sal.dom.api.DOMNotification;
  18 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationService;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  20 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  21 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
  22 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
  23 import org.opendaylight.controller.sal.core.api.Broker;
  24 import org.opendaylight.controller.sal.core.api.Provider;
  25 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  26 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 final class NetconfDeviceSalProvider implements AutoCloseable, Provider, BindingAwareProvider {
  31
  32     private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceSalProvider.class);
  33
  34     private final RemoteDeviceId id;
  35     private MountInstance mountInstance;
  36
  37     private volatile NetconfDeviceTopologyAdapter topologyDatastoreAdapter;
  38
  39     public NetconfDeviceSalProvider(final RemoteDeviceId deviceId) {
  40         this.id = deviceId;
  41     }
  42
  43     public MountInstance getMountInstance() {
  44         Preconditions.checkState(mountInstance != null,
  45                 "%s: Mount instance was not initialized by sal. Cannot get mount instance", id);
  46         return mountInstance;
  47     }
  48
  49     public NetconfDeviceTopologyAdapter getTopologyDatastoreAdapter() {
  50         Preconditions.checkState(topologyDatastoreAdapter != null,
  51                 "%s: Sal provider %s was not initialized by sal. Cannot get topology datastore adapter", id);
  52         return topologyDatastoreAdapter;
  53     }
  54
  55     @Override
  56     public void onSessionInitiated(final Broker.ProviderSession session) {
  57         LOG.debug("{}: (BI)Session with sal established {}", id, session);
  58
  59         final DOMMountPointService mountService = session.getService(DOMMountPointService.class);
  60         if (mountService != null) {
  61             mountInstance = new MountInstance(mountService, id);
  62         }
  63     }
  64
  65     @Override
  66     public Collection<Provider.ProviderFunctionality> getProviderFunctionality() {
  67         return Collections.emptySet();
  68     }
  69
  70     @Override
  71     public void onSessionInitiated(final BindingAwareBroker.ProviderContext session) {
  72         LOG.debug("{}: Session with sal established {}", id, session);
  73
  74         final DataBroker dataBroker = session.getSALService(DataBroker.class);
  75
  76         topologyDatastoreAdapter = new NetconfDeviceTopologyAdapter(id, dataBroker);
  77     }
  78
  79     public void close() throws Exception {
  80         mountInstance.close();
  81         topologyDatastoreAdapter.close();
  82         topologyDatastoreAdapter = null;
  83     }
  84
  85     static final class MountInstance implements AutoCloseable {
  86
  87         private DOMMountPointService mountService;
  88         private final RemoteDeviceId id;
  89         private NetconfDeviceNotificationService notificationService;
  90
  91         private ObjectRegistration<DOMMountPoint> topologyRegistration;
  92
  93         MountInstance(final DOMMountPointService mountService, final RemoteDeviceId id) {
  94             this.mountService = Preconditions.checkNotNull(mountService);
  95             this.id = Preconditions.checkNotNull(id);
  96         }
  97
  98         synchronized void onTopologyDeviceConnected(final SchemaContext initialCtx,
  99                                                     final DOMDataBroker broker, final DOMRpcService rpc,
 100                                                     final NetconfDeviceNotificationService notificationService) {
 101
 102             Preconditions.checkNotNull(mountService, "Closed");
 103             Preconditions.checkState(topologyRegistration == null, "Already initialized");
 104
 105             final DOMMountPointService.DOMMountPointBuilder mountBuilder = mountService.createMountPoint(id.getTopologyPath());
 106             mountBuilder.addInitialSchemaContext(initialCtx);
 107
 108             mountBuilder.addService(DOMDataBroker.class, broker);
 109             mountBuilder.addService(DOMRpcService.class, rpc);
 110             mountBuilder.addService(DOMNotificationService.class, notificationService);
 111             this.notificationService = notificationService;
 112
 113             topologyRegistration = mountBuilder.register();
 114             LOG.debug("{}: TOPOLOGY Mountpoint exposed into MD-SAL {}", id,
 115                     topologyRegistration);
 116
 117         }
 118
 119         synchronized void onTopologyDeviceDisconnected() {
 120             if(topologyRegistration == null) {
 121                 LOG.trace(
 122                         "{}: Not removing TOPOLOGY mountpoint from MD-SAL, mountpoint was not registered yet",
 123                         id);
 124                 return;
 125             }
 126
 127             try {
 128                 topologyRegistration.close();
 129             } catch (final Exception e) {
 130                 // Only log and ignore
 131                 LOG.warn(
 132                         "Unable to unregister mount instance for {}. Ignoring exception",
 133                         id.getTopologyPath(), e);
 134             } finally {
 135                 LOG.debug("{}: TOPOLOGY Mountpoint removed from MD-SAL {}",
 136                         id, topologyRegistration);
 137                 topologyRegistration = null;
 138             }
 139         }
 140
 141         @Override
 142         synchronized public void close() throws Exception {
 143             onTopologyDeviceDisconnected();
 144             mountService = null;
 145         }
 146
 147         public synchronized void publish(final DOMNotification domNotification) {
 148             Preconditions.checkNotNull(notificationService, "Device not set up yet, cannot handle notification {}", domNotification);
 149             notificationService.publishNotification(domNotification);
 150         }
 151     }
 152
 153 }