opendaylight/md-sal/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 java.util.concurrent.ExecutorService;
  14 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  15 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  16 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  17 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  18 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  19 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
  20 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
  21 import org.opendaylight.controller.sal.core.api.Broker;
  22 import org.opendaylight.controller.sal.core.api.Provider;
  23 import org.opendaylight.controller.sal.core.api.RpcProvisionRegistry;
  24 import org.opendaylight.controller.sal.core.api.notify.NotificationPublishService;
  25 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  26 import org.opendaylight.yangtools.yang.binding.RpcService;
  27 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  28 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 final class NetconfDeviceSalProvider implements AutoCloseable, Provider, BindingAwareProvider {
  33
  34     private static final Logger logger = LoggerFactory.getLogger(NetconfDeviceSalProvider.class);
  35
  36     private final RemoteDeviceId id;
  37     private final ExecutorService executor;
  38     private volatile NetconfDeviceDatastoreAdapter datastoreAdapter;
  39     private MountInstance mountInstance;
  40
  41     public NetconfDeviceSalProvider(final RemoteDeviceId deviceId, final ExecutorService executor) {
  42         this.id = deviceId;
  43         this.executor = executor;
  44     }
  45
  46     public MountInstance getMountInstance() {
  47         Preconditions.checkState(mountInstance != null,
  48                 "%s: Mount instance was not initialized by sal. Cannot get mount instance", id);
  49         return mountInstance;
  50     }
  51
  52     public NetconfDeviceDatastoreAdapter getDatastoreAdapter() {
  53         Preconditions.checkState(datastoreAdapter != null,
  54                 "%s: Sal provider %s was not initialized by sal. Cannot get datastore adapter", id);
  55         return datastoreAdapter;
  56     }
  57
  58     @Override
  59     public void onSessionInitiated(final Broker.ProviderSession session) {
  60         logger.debug("{}: (BI)Session with sal established {}", id, session);
  61
  62         final DOMMountPointService mountService = session.getService(DOMMountPointService.class);
  63         if (mountService != null) {
  64             mountInstance = new MountInstance(mountService, id);
  65         }
  66     }
  67
  68     @Override
  69     public Collection<Provider.ProviderFunctionality> getProviderFunctionality() {
  70         return Collections.emptySet();
  71     }
  72
  73     @Override
  74     public Collection<? extends RpcService> getImplementations() {
  75         return Collections.emptySet();
  76     }
  77
  78     @Override
  79     public Collection<? extends BindingAwareProvider.ProviderFunctionality> getFunctionality() {
  80         return Collections.emptySet();
  81     }
  82
  83     @Override
  84     public void onSessionInitiated(final BindingAwareBroker.ProviderContext session) {
  85         logger.debug("{}: Session with sal established {}", id, session);
  86
  87         final DataBroker dataBroker = session.getSALService(DataBroker.class);
  88         datastoreAdapter = new NetconfDeviceDatastoreAdapter(id, dataBroker);
  89     }
  90
  91     @Override
  92     public void onSessionInitialized(final BindingAwareBroker.ConsumerContext session) {}
  93
  94     public void close() throws Exception {
  95         mountInstance.close();
  96         datastoreAdapter.close();
  97         datastoreAdapter = null;
  98     }
  99
 100     static final class MountInstance implements AutoCloseable {
 101
 102         private DOMMountPointService mountService;
 103         private final RemoteDeviceId id;
 104         private ObjectRegistration<DOMMountPoint> registration;
 105         private NotificationPublishService notificationSerivce;
 106
 107         MountInstance(final DOMMountPointService mountService, final RemoteDeviceId id) {
 108             this.mountService = Preconditions.checkNotNull(mountService);
 109             this.id = Preconditions.checkNotNull(id);
 110         }
 111
 112         synchronized void onDeviceConnected(final SchemaContext initialCtx,
 113                 final DOMDataBroker broker, final RpcProvisionRegistry rpc,
 114                 final NotificationPublishService notificationSerivce) {
 115
 116             Preconditions.checkNotNull(mountService, "Closed");
 117             Preconditions.checkState(registration == null, "Already initialized");
 118
 119             final DOMMountPointService.DOMMountPointBuilder mountBuilder = mountService.createMountPoint(id.getPath());
 120             mountBuilder.addInitialSchemaContext(initialCtx);
 121
 122             mountBuilder.addService(DOMDataBroker.class, broker);
 123             mountBuilder.addService(RpcProvisionRegistry.class, rpc);
 124             this.notificationSerivce = notificationSerivce;
 125             mountBuilder.addService(NotificationPublishService.class, notificationSerivce);
 126
 127             registration = mountBuilder.register();
 128         }
 129
 130         synchronized void onDeviceDisconnected() {
 131             if(registration == null) {
 132                 return;
 133             }
 134
 135             try {
 136                 registration.close();
 137             } catch (final Exception e) {
 138                 // Only log and ignore
 139                 logger.warn("Unable to unregister mount instance for {}. Ignoring exception", id.getPath(), e);
 140             } finally {
 141                 registration = null;
 142             }
 143         }
 144
 145         @Override
 146         synchronized public void close() throws Exception {
 147             if(registration != null) {
 148                 onDeviceDisconnected();
 149             }
 150             mountService = null;
 151         }
 152
 153         public synchronized void publish(final CompositeNode domNotification) {
 154             Preconditions.checkNotNull(notificationSerivce, "Device not set up yet, cannot handle notification {}", domNotification);
 155             notificationSerivce.publish(domNotification);
 156         }
 157     }
 158
 159 }