opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/sal/NetconfDeviceDatastoreAdapter.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.Function;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.FluentIterable;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.ListeningExecutorService;
  17 import com.google.common.util.concurrent.MoreExecutors;
  18 import java.util.Set;
  19 import java.util.concurrent.ExecutionException;
  20 import java.util.concurrent.ExecutorService;
  21 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  22 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  23 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  24 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.inventory.rev140108.NetconfNode;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.inventory.rev140108.NetconfNodeBuilder;
  29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  30 import org.opendaylight.yangtools.yang.common.QName;
  31 import org.opendaylight.yangtools.yang.common.RpcResult;
  32 import org.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34
  35 /**
  36  * Asynchronous (Binding-aware) adapter over datastore subtree for netconf device.
  37  *
  38  * All data changes are submitted to an ExecutorService to avoid Thread blocking while sal is waiting for schema.
  39  */
  40 final class NetconfDeviceDatastoreAdapter implements AutoCloseable {
  41
  42     private static final Logger logger  = LoggerFactory.getLogger(NetconfDeviceDatastoreAdapter.class);
  43
  44     private final RemoteDeviceId id;
  45     private final DataProviderService dataService;
  46     private final ListeningExecutorService executor;
  47
  48     NetconfDeviceDatastoreAdapter(final RemoteDeviceId deviceId, final DataProviderService dataService,
  49             final ExecutorService executor) {
  50         this.id = Preconditions.checkNotNull(deviceId);
  51         this.dataService = Preconditions.checkNotNull(dataService);
  52         this.executor = MoreExecutors.listeningDecorator(Preconditions.checkNotNull(executor));
  53
  54         // Initial data change scheduled
  55         submitDataChangeToExecutor(this.executor, new Runnable() {
  56             @Override
  57             public void run() {
  58                 initDeviceData();
  59             }
  60         }, deviceId);
  61     }
  62
  63     public void updateDeviceState(final boolean up, final Set<QName> capabilities) {
  64         submitDataChangeToExecutor(this.executor, new Runnable() {
  65             @Override
  66             public void run() {
  67                 updateDeviceStateInternal(up, capabilities);
  68             }
  69         }, id);
  70     }
  71
  72     private void updateDeviceStateInternal(final boolean up, final Set<QName> capabilities) {
  73         final org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node data = buildDataForDeviceState(
  74                 up, capabilities, id);
  75
  76         final DataModificationTransaction transaction = dataService.beginTransaction();
  77         logger.trace("{}: Update device state transaction {} putting operational data started.", id, transaction.getIdentifier());
  78         transaction.removeOperationalData(id.getBindingPath());
  79         transaction.putOperationalData(id.getBindingPath(), data);
  80         logger.trace("{}: Update device state transaction {} putting operational data ended.", id, transaction.getIdentifier());
  81
  82         commitTransaction(transaction, "update");
  83     }
  84
  85     private void removeDeviceConfigAndState() {
  86         final DataModificationTransaction transaction = dataService.beginTransaction();
  87         logger.trace("{}: Close device state transaction {} removing all data started.", id, transaction.getIdentifier());
  88         transaction.removeConfigurationData(id.getBindingPath());
  89         transaction.removeOperationalData(id.getBindingPath());
  90         logger.trace("{}: Close device state transaction {} removing all data ended.", id, transaction.getIdentifier());
  91
  92         commitTransaction(transaction, "close");
  93     }
  94
  95     private void initDeviceData() {
  96         final DataModificationTransaction transaction = dataService.beginTransaction();
  97
  98         final InstanceIdentifier<Node> path = id.getBindingPath();
  99
 100         final Node nodeWithId = getNodeWithId(id);
 101         if (operationalNodeNotExisting(transaction, path)) {
 102             transaction.putOperationalData(path, nodeWithId);
 103         }
 104         if (configurationNodeNotExisting(transaction, path)) {
 105             transaction.putConfigurationData(path, nodeWithId);
 106         }
 107
 108         commitTransaction(transaction, "init");
 109     }
 110
 111     private void commitTransaction(final DataModificationTransaction transaction, final String txType) {
 112         // attempt commit
 113         final RpcResult<TransactionStatus> result;
 114         try {
 115             result = transaction.commit().get();
 116         } catch (InterruptedException | ExecutionException e) {
 117             logger.error("{}: Transaction({}) failed", id, txType, e);
 118             throw new IllegalStateException(id + " Transaction(" + txType + ") not committed correctly", e);
 119         }
 120
 121         // verify success result + committed state
 122         if (isUpdateSuccessful(result)) {
 123             logger.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType, transaction.getIdentifier());
 124         } else {
 125             logger.error("{}: Transaction({}) {} FAILED!", id, txType, transaction.getIdentifier());
 126             throw new IllegalStateException(id + "  Transaction(" + txType + ") not committed correctly, " +
 127                     "Errors: " + result.getErrors());
 128         }
 129     }
 130
 131     @Override
 132     public void close() throws Exception {
 133         // Remove device data from datastore
 134         submitDataChangeToExecutor(executor, new Runnable() {
 135             @Override
 136             public void run() {
 137                 removeDeviceConfigAndState();
 138             }
 139         }, id);
 140     }
 141
 142     private static boolean isUpdateSuccessful(final RpcResult<TransactionStatus> result) {
 143         return result.getResult() == TransactionStatus.COMMITED && result.isSuccessful();
 144     }
 145
 146     private static void submitDataChangeToExecutor(final ListeningExecutorService executor, final Runnable r,
 147             final RemoteDeviceId id) {
 148         // Submit data change
 149         final ListenableFuture<?> f = executor.submit(r);
 150         // Verify update execution
 151         Futures.addCallback(f, new FutureCallback<Object>() {
 152             @Override
 153             public void onSuccess(final Object result) {
 154                 logger.debug("{}: Device data updated successfully", id);
 155             }
 156
 157             @Override
 158             public void onFailure(final Throwable t) {
 159                 logger.warn("{}: Device data update failed", id, t);
 160             }
 161         });
 162     }
 163
 164     public static org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node buildDataForDeviceState(
 165             final boolean up, final Set<QName> capabilities, final RemoteDeviceId id) {
 166
 167         final NodeBuilder nodeBuilder = getNodeWithIdBuilder(id);
 168         final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
 169         netconfNodeBuilder.setConnected(up);
 170         netconfNodeBuilder.setInitialCapability(FluentIterable.from(capabilities)
 171                 .transform(new Function<QName, String>() {
 172                     @Override
 173                     public String apply(final QName input) {
 174                         return input.toString();
 175                     }
 176                 }).toList());
 177         nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
 178
 179         return nodeBuilder.build();
 180     }
 181
 182     private static boolean configurationNodeNotExisting(final DataModificationTransaction transaction,
 183             final InstanceIdentifier<Node> path) {
 184         return null == transaction.readConfigurationData(path);
 185     }
 186
 187     private static boolean operationalNodeNotExisting(final DataModificationTransaction transaction,
 188             final InstanceIdentifier<Node> path) {
 189         return null == transaction.readOperationalData(path);
 190     }
 191
 192     private static Node getNodeWithId(final RemoteDeviceId id) {
 193         final NodeBuilder nodeBuilder = getNodeWithIdBuilder(id);
 194         return nodeBuilder.build();
 195     }
 196
 197     private static NodeBuilder getNodeWithIdBuilder(final RemoteDeviceId id) {
 198         final NodeBuilder nodeBuilder = new NodeBuilder();
 199         nodeBuilder.setKey(id.getBindingKey());
 200         nodeBuilder.setId(id.getBindingKey().getId());
 201         return nodeBuilder;
 202     }
 203 }