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