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.tx;
10 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.CONFIG_SOURCE_RUNNING;
11 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DATA_QNAME;
12 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME;
13 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
14 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.toFilterStructure;
16 import com.google.common.base.Function;
17 import com.google.common.base.Optional;
18 import com.google.common.base.Preconditions;
19 import com.google.common.util.concurrent.CheckedFuture;
20 import com.google.common.util.concurrent.Futures;
21 import com.google.common.util.concurrent.ListenableFuture;
22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
23 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
24 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException;
25 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer;
26 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
27 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
28 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
29 import org.opendaylight.controller.sal.core.api.RpcImplementation;
30 import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
31 import org.opendaylight.yangtools.yang.common.RpcResult;
32 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
39 public final class NetconfDeviceReadOnlyTx implements DOMDataReadOnlyTransaction {
41 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceReadOnlyTx.class);
43 private final RpcImplementation rpc;
44 private final DataNormalizer normalizer;
45 private final RemoteDeviceId id;
47 public NetconfDeviceReadOnlyTx(final RpcImplementation rpc, final DataNormalizer normalizer, final RemoteDeviceId id) {
49 this.normalizer = normalizer;
53 private CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> readConfigurationData(
54 final YangInstanceIdentifier path) {
55 final ListenableFuture<RpcResult<CompositeNode>> future = rpc.invokeRpc(NETCONF_GET_CONFIG_QNAME,
56 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, CONFIG_SOURCE_RUNNING, toFilterStructure(path)));
58 ListenableFuture<Optional<NormalizedNode<?, ?>>> transformedFuture = Futures.transform(future, new Function<RpcResult<CompositeNode>, Optional<NormalizedNode<?, ?>>>() {
60 public Optional<NormalizedNode<?, ?>> apply(final RpcResult<CompositeNode> result) {
61 checkReadSuccess(result, path);
63 final CompositeNode data = result.getResult().getFirstCompositeByName(NETCONF_DATA_QNAME);
64 final CompositeNode node = (CompositeNode) NetconfMessageTransformUtil.findNode(data, path);
67 Optional.<NormalizedNode<?, ?>>absent() :
68 transform(path, node);
72 return MappingCheckedFuture.create(transformedFuture, ReadFailedException.MAPPER);
75 private void checkReadSuccess(final RpcResult<CompositeNode> result, final YangInstanceIdentifier path) {
77 Preconditions.checkArgument(result.isSuccessful(), "%s: Unable to read data: %s, errors: %s", id, path, result.getErrors());
78 } catch (IllegalArgumentException e) {
79 LOG.warn("{}: Unable to read data: {}, errors: {}", id, path, result.getErrors());
84 private Optional<NormalizedNode<?, ?>> transform(final YangInstanceIdentifier path, final CompositeNode node) {
86 return Optional.absent();
89 return Optional.<NormalizedNode<?, ?>>of(normalizer.toNormalized(path, node).getValue());
90 } catch (final Exception e) {
91 LOG.error("{}: Unable to normalize data for {}, data: {}", id, path, node, e);
96 private CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> readOperationalData(
97 final YangInstanceIdentifier path) {
98 final ListenableFuture<RpcResult<CompositeNode>> future = rpc.invokeRpc(NETCONF_GET_QNAME, NetconfMessageTransformUtil.wrap(NETCONF_GET_QNAME, toFilterStructure(path)));
100 ListenableFuture<Optional<NormalizedNode<?, ?>>> transformedFuture = Futures.transform(future, new Function<RpcResult<CompositeNode>, Optional<NormalizedNode<?, ?>>>() {
102 public Optional<NormalizedNode<?, ?>> apply(final RpcResult<CompositeNode> result) {
103 checkReadSuccess(result, path);
105 final CompositeNode data = result.getResult().getFirstCompositeByName(NETCONF_DATA_QNAME);
106 final CompositeNode node = (CompositeNode) NetconfMessageTransformUtil.findNode(data, path);
108 return data == null ?
109 Optional.<NormalizedNode<?, ?>>absent() :
110 transform(path, node);
114 return MappingCheckedFuture.create(transformedFuture, ReadFailedException.MAPPER);
118 public void close() {
123 public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(
124 final LogicalDatastoreType store, final YangInstanceIdentifier path) {
125 final YangInstanceIdentifier legacyPath = toLegacyPath(normalizer, path, id);
128 case CONFIGURATION : {
129 return readConfigurationData(legacyPath);
132 return readOperationalData(legacyPath);
136 throw new IllegalArgumentException(String.format("%s, Cannot read data %s for %s datastore, unknown datastore type", id, path, store));
139 static YangInstanceIdentifier toLegacyPath(final DataNormalizer normalizer, final YangInstanceIdentifier path, final RemoteDeviceId id) {
141 return normalizer.toLegacy(path);
142 } catch (final DataNormalizationException e) {
143 throw new IllegalArgumentException(id + ": Cannot normalize path " + path, e);
148 public Object getIdentifier() {