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.sal.connect.netconf.schema;
10 import static com.google.common.base.Preconditions.checkState;
11 import static java.util.Objects.requireNonNull;
12 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.GET_SCHEMA_QNAME;
13 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DATA_QNAME;
15 import com.google.common.base.MoreObjects;
16 import com.google.common.util.concurrent.Futures;
17 import com.google.common.util.concurrent.ListenableFuture;
18 import com.google.common.util.concurrent.MoreExecutors;
19 import java.io.ByteArrayInputStream;
20 import java.io.InputStream;
21 import java.nio.charset.StandardCharsets;
22 import java.util.Optional;
23 import javax.xml.transform.dom.DOMSource;
24 import org.opendaylight.mdsal.dom.api.DOMRpcService;
25 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
26 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
28 import org.opendaylight.yangtools.yang.common.QName;
29 import org.opendaylight.yangtools.yang.common.Revision;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
31 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
34 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
36 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
38 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
39 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
40 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
41 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
44 import org.w3c.dom.Element;
46 public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSourceProvider<YangTextSchemaSource> {
47 private static final Logger LOG = LoggerFactory.getLogger(NetconfRemoteSchemaYangSourceProvider.class);
48 private static final NodeIdentifier FORMAT_PATHARG =
49 NodeIdentifier.create(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format").intern());
50 private static final NodeIdentifier GET_SCHEMA_PATHARG =
51 NodeIdentifier.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME);
52 private static final NodeIdentifier IDENTIFIER_PATHARG =
53 NodeIdentifier.create(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier").intern());
54 private static final NodeIdentifier VERSION_PATHARG =
55 NodeIdentifier.create(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version").intern());
56 private static final LeafNode<?> FORMAT_LEAF =
57 Builders.leafBuilder().withNodeIdentifier(FORMAT_PATHARG).withValue(Yang.QNAME).build();
58 private static final QName NETCONF_DATA =
59 QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()).intern();
60 private static final NodeIdentifier NETCONF_DATA_PATHARG = NodeIdentifier.create(NETCONF_DATA);
62 private final DOMRpcService rpc;
63 private final RemoteDeviceId id;
65 public NetconfRemoteSchemaYangSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
67 this.rpc = requireNonNull(rpc);
70 public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
71 final LeafNode<?> identifier =
72 Builders.leafBuilder().withNodeIdentifier(IDENTIFIER_PATHARG).withValue(moduleName).build();
73 final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> builder = Builders.containerBuilder()
74 .withNodeIdentifier(GET_SCHEMA_PATHARG).withChild(identifier).withChild(FORMAT_LEAF);
76 if (revision.isPresent()) {
77 builder.withChild(Builders.leafBuilder()
78 .withNodeIdentifier(VERSION_PATHARG).withValue(revision.get()).build());
81 return builder.build();
84 private static Optional<String> getSchemaFromRpc(final RemoteDeviceId id, final NormalizedNode<?, ?> result) {
86 return Optional.empty();
89 final Optional<DataContainerChild<?, ?>> child = ((ContainerNode) result).getChild(NETCONF_DATA_PATHARG);
90 checkState(child.isPresent() && child.get() instanceof AnyXmlNode,
91 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
92 NETCONF_DATA, result);
94 final DOMSource wrappedNode = ((AnyXmlNode) child.get()).getValue();
95 final Element dataNode = (Element) requireNonNull(wrappedNode.getNode());
97 return Optional.of(dataNode.getTextContent().trim());
101 public ListenableFuture<YangTextSchemaSource> getSource(final SourceIdentifier sourceIdentifier) {
102 final String moduleName = sourceIdentifier.getName();
104 final Optional<String> revision = sourceIdentifier.getRevision().map(Revision::toString);
105 final NormalizedNode<?, ?> getSchemaRequest = createGetSchemaRequest(moduleName, revision);
106 LOG.trace("{}: Loading YANG schema source for {}:{}", id, moduleName, revision);
107 return Futures.transform(
108 rpc.invokeRpc(SchemaPath.create(true, NetconfMessageTransformUtil.GET_SCHEMA_QNAME), getSchemaRequest),
110 // Transform composite node to string schema representation and then to ASTSchemaSource.
111 if (input.getErrors().isEmpty()) {
112 final Optional<String> schemaString = getSchemaFromRpc(id, input.getResult());
113 checkState(schemaString.isPresent(),
114 "%s: Unexpected response to get-schema, schema not present in message for: %s", id,
116 LOG.debug("{}: YANG Schema successfully retrieved for {}:{}", id, moduleName, revision);
117 return new NetconfYangTextSchemaSource(id, sourceIdentifier, schemaString);
120 LOG.warn("{}: YANG schema was not successfully retrieved for {}. Errors: {}", id, sourceIdentifier,
122 throw new IllegalStateException(String.format(
123 "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
125 }, MoreExecutors.directExecutor());
128 static class NetconfYangTextSchemaSource extends YangTextSchemaSource {
129 private final RemoteDeviceId id;
130 private final Optional<String> schemaString;
132 NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
133 final Optional<String> schemaString) {
134 super(sourceIdentifier);
136 this.schemaString = schemaString;
140 protected MoreObjects.ToStringHelper addToStringAttributes(final MoreObjects.ToStringHelper toStringHelper) {
141 return toStringHelper.add("device", id);
145 public InputStream openStream() {
146 return new ByteArrayInputStream(schemaString.get().getBytes(StandardCharsets.UTF_8));