2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.sal.connect.netconf.sal;
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;
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;
36 * Asynchronous (Binding-aware) adapter over datastore subtree for netconf device.
38 * All data changes are submitted to an ExecutorService to avoid Thread blocking while sal is waiting for schema.
40 final class NetconfDeviceDatastoreAdapter implements AutoCloseable {
42 private static final Logger logger = LoggerFactory.getLogger(NetconfDeviceDatastoreAdapter.class);
44 private final RemoteDeviceId id;
45 private final DataProviderService dataService;
46 private final ListeningExecutorService executor;
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));
54 // Initial data change scheduled
55 submitDataChangeToExecutor(this.executor, new Runnable() {
63 public void updateDeviceState(final boolean up, final Set<QName> capabilities) {
64 submitDataChangeToExecutor(this.executor, new Runnable() {
67 updateDeviceStateInternal(up, capabilities);
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);
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());
82 commitTransaction(transaction, "update");
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());
92 commitTransaction(transaction, "close");
95 private void initDeviceData() {
96 final DataModificationTransaction transaction = dataService.beginTransaction();
98 final InstanceIdentifier<Node> path = id.getBindingPath();
100 final Node nodeWithId = getNodeWithId(id);
101 if (operationalNodeNotExisting(transaction, path)) {
102 transaction.putOperationalData(path, nodeWithId);
104 if (configurationNodeNotExisting(transaction, path)) {
105 transaction.putConfigurationData(path, nodeWithId);
108 commitTransaction(transaction, "init");
111 private void commitTransaction(final DataModificationTransaction transaction, final String txType) {
113 final RpcResult<TransactionStatus> result;
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);
121 // verify success result + committed state
122 if (isUpdateSuccessful(result)) {
123 logger.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType, transaction.getIdentifier());
125 logger.error("{}: Transaction({}) {} FAILED!", id, txType, transaction.getIdentifier());
126 throw new IllegalStateException(id + " Transaction(" + txType + ") not committed correctly, " +
127 "Errors: " + result.getErrors());
132 public void close() throws Exception {
133 // Remove device data from datastore
134 submitDataChangeToExecutor(executor, new Runnable() {
137 removeDeviceConfigAndState();
142 private static boolean isUpdateSuccessful(final RpcResult<TransactionStatus> result) {
143 return result.getResult() == TransactionStatus.COMMITED && result.isSuccessful();
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>() {
153 public void onSuccess(final Object result) {
154 logger.debug("{}: Device data updated successfully", id);
158 public void onFailure(final Throwable t) {
159 logger.warn("{}: Device data update failed", id, t);
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) {
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>() {
173 public String apply(final QName input) {
174 return input.toString();
177 nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
179 return nodeBuilder.build();
182 private static boolean configurationNodeNotExisting(final DataModificationTransaction transaction,
183 final InstanceIdentifier<Node> path) {
184 return null == transaction.readConfigurationData(path);
187 private static boolean operationalNodeNotExisting(final DataModificationTransaction transaction,
188 final InstanceIdentifier<Node> path) {
189 return null == transaction.readOperationalData(path);
192 private static Node getNodeWithId(final RemoteDeviceId id) {
193 final NodeBuilder nodeBuilder = getNodeWithIdBuilder(id);
194 return nodeBuilder.build();
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());