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 org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.GET_SCHEMA_QNAME;
11 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DATA_QNAME;
12 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toId;
14 import com.google.common.base.Charsets;
15 import com.google.common.base.Function;
16 import com.google.common.base.MoreObjects;
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 java.io.ByteArrayInputStream;
23 import java.io.IOException;
24 import java.io.InputStream;
25 import javax.xml.transform.dom.DOMSource;
26 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
27 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
28 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
29 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
31 import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
32 import org.opendaylight.yangtools.yang.common.QName;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
38 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
40 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
42 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
43 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException;
44 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
45 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
46 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
49 import org.w3c.dom.Element;
51 public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSourceProvider<YangTextSchemaSource> {
53 private static final Logger LOG = LoggerFactory.getLogger(NetconfRemoteSchemaYangSourceProvider.class);
55 private static final ExceptionMapper<SchemaSourceException> MAPPER = new ExceptionMapper<SchemaSourceException>(
56 "schemaDownload", SchemaSourceException.class) {
58 protected SchemaSourceException newWithCause(final String s, final Throwable throwable) {
59 return new SchemaSourceException(s, throwable);
63 private final DOMRpcService rpc;
64 private final RemoteDeviceId id;
66 public NetconfRemoteSchemaYangSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
68 this.rpc = Preconditions.checkNotNull(rpc);
71 private static final NodeIdentifier FORMAT_PATHARG = new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format").intern());
72 private static final NodeIdentifier GET_SCHEMA_PATHARG = new NodeIdentifier(NetconfMessageTransformUtil.GET_SCHEMA_QNAME);
73 private static final NodeIdentifier IDENTIFIER_PATHARG = new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier").intern());
74 private static final NodeIdentifier VERSION_PATHARG = new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version").intern());
76 private static final LeafNode<?> FORMAT_LEAF = Builders.leafBuilder().withNodeIdentifier(FORMAT_PATHARG).withValue(Yang.QNAME).build();
78 private static final QName NETCONF_DATA = QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()).intern();
79 private static final NodeIdentifier NETCONF_DATA_PATHARG = toId(NETCONF_DATA);
81 public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
82 final LeafNode<?> identifier = Builders.leafBuilder().withNodeIdentifier(IDENTIFIER_PATHARG).withValue(moduleName).build();
83 final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> builder = Builders.containerBuilder()
84 .withNodeIdentifier(GET_SCHEMA_PATHARG).withChild(identifier).withChild(FORMAT_LEAF);
86 if (revision.isPresent()) {
87 builder.withChild(Builders.leafBuilder().withNodeIdentifier(VERSION_PATHARG).withValue(revision.get()).build());
90 return builder.build();
93 private static Optional<String> getSchemaFromRpc(final RemoteDeviceId id, final NormalizedNode<?, ?> result) {
95 return Optional.absent();
98 final Optional<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> child = ((ContainerNode) result).getChild(NETCONF_DATA_PATHARG);
100 Preconditions.checkState(child.isPresent() && child.get() instanceof AnyXmlNode,
101 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
102 NETCONF_DATA, result);
104 final DOMSource wrappedNode = ((AnyXmlNode) child.get()).getValue();
105 Preconditions.checkNotNull(wrappedNode.getNode());
106 final Element dataNode = (Element) wrappedNode.getNode();
108 return Optional.of(dataNode.getTextContent().trim());
112 public CheckedFuture<YangTextSchemaSource, SchemaSourceException> getSource(final SourceIdentifier sourceIdentifier) {
113 final String moduleName = sourceIdentifier.getName();
115 // If formatted revision is SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION, we have to omit it from request
116 final String formattedRevision = sourceIdentifier.getRevision().equals(SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION) ? null : sourceIdentifier.getRevision();
117 final Optional<String> revision = Optional.fromNullable(formattedRevision);
118 final NormalizedNode<?, ?> getSchemaRequest = createGetSchemaRequest(moduleName, revision);
120 LOG.trace("{}: Loading YANG schema source for {}:{}", id, moduleName,
123 final ListenableFuture<YangTextSchemaSource> transformed = Futures.transform(
124 rpc.invokeRpc(SchemaPath.create(true, NetconfMessageTransformUtil.GET_SCHEMA_QNAME), getSchemaRequest),
125 new ResultToYangSourceTransformer(id, sourceIdentifier, moduleName, revision));
127 final CheckedFuture<YangTextSchemaSource, SchemaSourceException> checked = Futures.makeChecked(transformed, MAPPER);
133 * Transform composite node to string schema representation and then to ASTSchemaSource
135 private static final class ResultToYangSourceTransformer implements
136 Function<DOMRpcResult, YangTextSchemaSource> {
138 private final RemoteDeviceId id;
139 private final SourceIdentifier sourceIdentifier;
140 private final String moduleName;
141 private final Optional<String> revision;
143 public ResultToYangSourceTransformer(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
144 final String moduleName, final Optional<String> revision) {
146 this.sourceIdentifier = sourceIdentifier;
147 this.moduleName = moduleName;
148 this.revision = revision;
152 public YangTextSchemaSource apply(final DOMRpcResult input) {
154 if (input.getErrors().isEmpty()) {
156 final Optional<String> schemaString = getSchemaFromRpc(id, input.getResult());
158 Preconditions.checkState(schemaString.isPresent(),
159 "%s: Unexpected response to get-schema, schema not present in message for: %s", id, sourceIdentifier);
161 LOG.debug("{}: YANG Schema successfully retrieved for {}:{}",
162 id, moduleName, revision);
163 return new NetconfYangTextSchemaSource(id, sourceIdentifier, schemaString);
167 "{}: YANG schema was not successfully retrieved for {}. Errors: {}",
168 id, sourceIdentifier, input.getErrors());
170 throw new IllegalStateException(String.format(
171 "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
177 static class NetconfYangTextSchemaSource extends YangTextSchemaSource {
178 private final RemoteDeviceId id;
179 private final Optional<String> schemaString;
181 public NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sId, final Optional<String> schemaString) {
184 this.schemaString = schemaString;
188 protected MoreObjects.ToStringHelper addToStringAttributes(final MoreObjects.ToStringHelper toStringHelper) {
189 return toStringHelper.add("device", id);
193 public InputStream openStream() throws IOException {
194 return new ByteArrayInputStream(schemaString.get().getBytes(Charsets.UTF_8));