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
9 package org.opendaylight.controller.sal.connect.netconf.sal.tx;
11 import com.google.common.base.Function;
12 import com.google.common.base.Optional;
13 import com.google.common.base.Preconditions;
14 import com.google.common.util.concurrent.CheckedFuture;
15 import com.google.common.util.concurrent.FutureCallback;
16 import com.google.common.util.concurrent.Futures;
17 import com.google.common.util.concurrent.ListenableFuture;
18 import java.util.concurrent.ExecutionException;
19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
20 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
21 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
22 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
23 import org.opendaylight.controller.sal.connect.netconf.util.NetconfBaseOps;
24 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
25 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
26 import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
28 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
30 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
36 public final class ReadOnlyTx implements DOMDataReadOnlyTransaction {
38 private static final Logger LOG = LoggerFactory.getLogger(ReadOnlyTx.class);
40 private final NetconfBaseOps netconfOps;
41 private final RemoteDeviceId id;
42 private final FutureCallback<DOMRpcResult> loggingCallback;
44 public ReadOnlyTx(final NetconfBaseOps netconfOps, final RemoteDeviceId id) {
45 this.netconfOps = netconfOps;
48 // Simple logging callback to log result of read operation
49 loggingCallback = new FutureCallback<DOMRpcResult>() {
51 public void onSuccess(final DOMRpcResult result) {
52 if(AbstractWriteTx.isSuccess(result)) {
53 LOG.trace("{}: Reading data successful", id);
55 LOG.warn("{}: Reading data unsuccessful: {}", id, result.getErrors());
61 public void onFailure(final Throwable t) {
62 LOG.warn("{}: Reading data failed", id, t);
67 private CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> readConfigurationData(
68 final YangInstanceIdentifier path) {
69 final ListenableFuture<DOMRpcResult> configRunning = netconfOps.getConfigRunning(loggingCallback, Optional.fromNullable(path));
71 final ListenableFuture<Optional<NormalizedNode<?, ?>>> transformedFuture = Futures.transform(configRunning, new Function<DOMRpcResult, Optional<NormalizedNode<?, ?>>>() {
73 public Optional<NormalizedNode<?, ?>> apply(final DOMRpcResult result) {
74 checkReadSuccess(result, path);
76 final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataNode = findDataNode(result);
77 return NormalizedNodes.findNode(dataNode, path.getPathArguments());
81 return MappingCheckedFuture.create(transformedFuture, ReadFailedException.MAPPER);
84 private DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> findDataNode(final DOMRpcResult result) {
85 return ((ContainerNode) result.getResult()).getChild(NetconfMessageTransformUtil.toId(NetconfMessageTransformUtil.NETCONF_DATA_QNAME)).get();
88 private void checkReadSuccess(final DOMRpcResult result, final YangInstanceIdentifier path) {
90 Preconditions.checkArgument(AbstractWriteTx.isSuccess(result), "%s: Unable to read data: %s, errors: %s", id, path, result.getErrors());
91 } catch (final IllegalArgumentException e) {
92 LOG.warn("{}: Unable to read data: {}, errors: {}", id, path, result.getErrors());
97 private CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> readOperationalData(
98 final YangInstanceIdentifier path) {
99 final ListenableFuture<DOMRpcResult> configCandidate = netconfOps.get(loggingCallback, Optional.fromNullable(path));
101 // Find data node and normalize its content
102 final ListenableFuture<Optional<NormalizedNode<?, ?>>> transformedFuture = Futures.transform(configCandidate, new Function<DOMRpcResult, Optional<NormalizedNode<?, ?>>>() {
104 public Optional<NormalizedNode<?, ?>> apply(final DOMRpcResult result) {
105 checkReadSuccess(result, path);
107 final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataNode = findDataNode(result);
108 return NormalizedNodes.findNode(dataNode, path.getPathArguments());
112 return MappingCheckedFuture.create(transformedFuture, ReadFailedException.MAPPER);
116 public void close() {
121 public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(
122 final LogicalDatastoreType store, final YangInstanceIdentifier path) {
124 case CONFIGURATION: {
125 return readConfigurationData(path);
128 return readOperationalData(path);
132 throw new IllegalArgumentException(String.format("%s, Cannot read data %s for %s datastore, unknown datastore type", id, path, store));
136 public CheckedFuture<Boolean, ReadFailedException> exists(final LogicalDatastoreType store, final YangInstanceIdentifier path) {
137 final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> data = read(store, path);
140 return Futures.immediateCheckedFuture(data.get().isPresent());
141 } catch (InterruptedException | ExecutionException e) {
142 return Futures.immediateFailedCheckedFuture(new ReadFailedException("Exists failed",e));
147 public Object getIdentifier() {