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.netconf.client.mdsal;
10 import static com.google.common.base.Preconditions.checkState;
11 import static java.util.Objects.requireNonNull;
12 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.GET_SCHEMA_QNAME;
13 import static org.opendaylight.netconf.common.mdsal.NormalizedDataUtil.NETCONF_DATA_QNAME;
15 import com.google.common.util.concurrent.Futures;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import com.google.common.util.concurrent.MoreExecutors;
18 import java.nio.charset.StandardCharsets;
19 import java.util.Optional;
20 import javax.xml.transform.dom.DOMSource;
21 import org.eclipse.jdt.annotation.NonNull;
22 import org.opendaylight.mdsal.dom.api.DOMRpcService;
23 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceId;
24 import org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil;
25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
26 import org.opendaylight.yangtools.yang.common.QName;
27 import org.opendaylight.yangtools.yang.common.Revision;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
29 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
32 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
33 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
34 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
35 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
36 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
37 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
40 import org.w3c.dom.Element;
43 * A {@link SchemaSourceProvider} producing {@link YangTextSchemaSource}s based on a device's
44 * {@code ietf-netconf-monitoring} interface. The set of available sources is not pre-determined and each request is
45 * dispatched to the device, i.e. this provider reflects real-time updates to available schemas.
47 public final class MonitoringSchemaSourceProvider implements SchemaSourceProvider<YangTextSchemaSource> {
48 private static final Logger LOG = LoggerFactory.getLogger(MonitoringSchemaSourceProvider.class);
49 private static final NodeIdentifier FORMAT_PATHARG =
50 NodeIdentifier.create(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format").intern());
51 private static final NodeIdentifier GET_SCHEMA_PATHARG =
52 NodeIdentifier.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME);
53 private static final NodeIdentifier IDENTIFIER_PATHARG =
54 NodeIdentifier.create(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier").intern());
55 private static final NodeIdentifier VERSION_PATHARG =
56 NodeIdentifier.create(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version").intern());
57 private static final LeafNode<?> FORMAT_LEAF =
58 Builders.leafBuilder().withNodeIdentifier(FORMAT_PATHARG).withValue(Yang.QNAME).build();
59 private static final QName NETCONF_DATA =
60 QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()).intern();
61 private static final NodeIdentifier NETCONF_DATA_PATHARG = NodeIdentifier.create(NETCONF_DATA);
63 private final DOMRpcService rpc;
64 private final RemoteDeviceId id;
66 public MonitoringSchemaSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
67 this.id = requireNonNull(id);
68 this.rpc = requireNonNull(rpc);
71 public static @NonNull ContainerNode createGetSchemaRequest(final String moduleName,
72 final Optional<String> revision) {
73 final var builder = Builders.containerBuilder()
74 .withNodeIdentifier(GET_SCHEMA_PATHARG)
75 .withChild(ImmutableNodes.leafNode(IDENTIFIER_PATHARG, moduleName))
76 .withChild(FORMAT_LEAF);
77 revision.ifPresent(rev -> builder.withChild(ImmutableNodes.leafNode(VERSION_PATHARG, rev)));
78 return builder.build();
81 private static Optional<String> getSchemaFromRpc(final RemoteDeviceId id, final ContainerNode result) {
83 return Optional.empty();
86 final DataContainerChild child = result.childByArg(NETCONF_DATA_PATHARG);
87 checkState(child instanceof DOMSourceAnyxmlNode,
88 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
89 NETCONF_DATA, result);
91 final DOMSource wrappedNode = ((DOMSourceAnyxmlNode) child).body();
92 final Element dataNode = (Element) requireNonNull(wrappedNode.getNode());
94 return Optional.of(dataNode.getTextContent().trim());
98 public ListenableFuture<YangTextSchemaSource> getSource(final SourceIdentifier sourceIdentifier) {
99 final String moduleName = sourceIdentifier.name().getLocalName();
101 final Optional<String> revision = Optional.ofNullable(sourceIdentifier.revision()).map(Revision::toString);
102 final ContainerNode getSchemaRequest = createGetSchemaRequest(moduleName, revision);
103 LOG.trace("{}: Loading YANG schema source for {}:{}", id, moduleName, revision);
104 return Futures.transform(
105 rpc.invokeRpc(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, getSchemaRequest), input -> {
106 // Transform composite node to string schema representation and then to ASTSchemaSource.
107 if (input.errors().isEmpty()) {
108 final String schemaString = getSchemaFromRpc(id, input.value())
109 .orElseThrow(() -> new IllegalStateException(
110 id + ": Unexpected response to get-schema, schema not present in message for: "
111 + sourceIdentifier));
112 LOG.debug("{}: YANG Schema successfully retrieved for {}:{}", id, moduleName, revision);
113 return new CachedYangTextSchemaSource(id, sourceIdentifier, moduleName,
114 schemaString.getBytes(StandardCharsets.UTF_8));
117 LOG.warn("{}: YANG schema was not successfully retrieved for {}. Errors: {}", id, sourceIdentifier,
119 throw new IllegalStateException(String.format(
120 "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
122 }, MoreExecutors.directExecutor());