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.schema;
10 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.GET_SCHEMA_QNAME;
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.toId;
14 import com.google.common.base.Function;
15 import com.google.common.base.MoreObjects;
16 import com.google.common.base.Optional;
17 import com.google.common.base.Preconditions;
18 import com.google.common.util.concurrent.CheckedFuture;
19 import com.google.common.util.concurrent.Futures;
20 import com.google.common.util.concurrent.ListenableFuture;
21 import java.io.IOException;
22 import java.io.InputStream;
23 import javax.xml.transform.dom.DOMSource;
24 import org.apache.commons.io.IOUtils;
25 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
26 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
27 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
28 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
30 import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
31 import org.opendaylight.yangtools.yang.common.QName;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
33 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
36 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
38 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
40 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
41 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException;
42 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
43 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
44 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
47 import org.w3c.dom.Element;
49 public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSourceProvider<YangTextSchemaSource> {
51 private static final Logger logger = LoggerFactory.getLogger(NetconfRemoteSchemaYangSourceProvider.class);
53 private static final ExceptionMapper<SchemaSourceException> MAPPER = new ExceptionMapper<SchemaSourceException>(
54 "schemaDownload", SchemaSourceException.class) {
56 protected SchemaSourceException newWithCause(final String s, final Throwable throwable) {
57 return new SchemaSourceException(s, throwable);
61 private final DOMRpcService rpc;
62 private final RemoteDeviceId id;
64 public NetconfRemoteSchemaYangSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
66 this.rpc = Preconditions.checkNotNull(rpc);
69 public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
70 final QName identifierQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier"));
71 final YangInstanceIdentifier.NodeIdentifier identifierId = new YangInstanceIdentifier.NodeIdentifier(identifierQName);
72 final LeafNode<String> identifier = Builders.<String>leafBuilder().withNodeIdentifier(identifierId).withValue(moduleName).build();
74 final QName formatQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format"));
75 final YangInstanceIdentifier.NodeIdentifier formatId = new YangInstanceIdentifier.NodeIdentifier(formatQName);
76 final LeafNode<QName> format = Builders.<QName>leafBuilder().withNodeIdentifier(formatId).withValue(Yang.QNAME).build();
78 final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> builder = Builders.containerBuilder();
80 builder.withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.GET_SCHEMA_QNAME))
81 .withChild(identifier)
84 if(revision.isPresent()) {
85 final QName revisionQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version"));
86 final YangInstanceIdentifier.NodeIdentifier revisionId = new YangInstanceIdentifier.NodeIdentifier(revisionQName);
87 final LeafNode<String> revisionNode = Builders.<String>leafBuilder().withNodeIdentifier(revisionId).withValue(revision.get()).build();
89 builder.withChild(revisionNode);
92 return builder.build();
95 private static Optional<String> getSchemaFromRpc(final RemoteDeviceId id, final NormalizedNode<?, ?> result) {
97 return Optional.absent();
100 final QName schemaWrapperNode = QName.cachedReference(QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()));
101 final Optional<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> child = ((ContainerNode) result).getChild(toId(schemaWrapperNode));
103 Preconditions.checkState(child.isPresent() && child.get() instanceof AnyXmlNode,
104 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
105 schemaWrapperNode, result);
107 final DOMSource wrappedNode = ((AnyXmlNode) child.get()).getValue();
108 Preconditions.checkNotNull(wrappedNode.getNode());
109 final Element dataNode = (Element) wrappedNode.getNode();
111 return Optional.of(dataNode.getTextContent().trim());
115 public CheckedFuture<YangTextSchemaSource, SchemaSourceException> getSource(final SourceIdentifier sourceIdentifier) {
116 final String moduleName = sourceIdentifier.getName();
118 // If formatted revision is SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION, we have to omit it from request
119 final String formattedRevision = sourceIdentifier.getRevision().equals(SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION) ? null : sourceIdentifier.getRevision();
120 final Optional<String> revision = Optional.fromNullable(formattedRevision);
121 final NormalizedNode<?, ?> getSchemaRequest = createGetSchemaRequest(moduleName, revision);
123 logger.trace("{}: Loading YANG schema source for {}:{}", id, moduleName, revision);
125 final ListenableFuture<YangTextSchemaSource> transformed = Futures.transform(
126 rpc.invokeRpc(SchemaPath.create(true, NetconfMessageTransformUtil.GET_SCHEMA_QNAME), getSchemaRequest),
127 new ResultToYangSourceTransformer(id, sourceIdentifier, moduleName, revision));
129 final CheckedFuture<YangTextSchemaSource, SchemaSourceException> checked = Futures.makeChecked(transformed, MAPPER);
131 // / FIXME remove this get, it is only present to wait until source is retrieved
132 // (goal is to limit concurrent schema download, since NetconfDevice listener does not handle concurrent messages properly)
135 logger.trace("{}: Blocking for {}", id, sourceIdentifier);
136 checked.checkedGet();
137 } catch (final SchemaSourceException e) {
138 return Futures.immediateFailedCheckedFuture(e);
145 * Transform composite node to string schema representation and then to ASTSchemaSource
147 private static final class ResultToYangSourceTransformer implements
148 Function<DOMRpcResult, YangTextSchemaSource> {
150 private final RemoteDeviceId id;
151 private final SourceIdentifier sourceIdentifier;
152 private final String moduleName;
153 private final Optional<String> revision;
155 public ResultToYangSourceTransformer(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
156 final String moduleName, final Optional<String> revision) {
158 this.sourceIdentifier = sourceIdentifier;
159 this.moduleName = moduleName;
160 this.revision = revision;
164 public YangTextSchemaSource apply(final DOMRpcResult input) {
166 if (input.getErrors().isEmpty()) {
168 final Optional<String> schemaString = getSchemaFromRpc(id, input.getResult());
170 Preconditions.checkState(schemaString.isPresent(),
171 "%s: Unexpected response to get-schema, schema not present in message for: %s", id, sourceIdentifier);
173 logger.debug("{}: YANG Schema successfully retrieved for {}:{}", id, moduleName, revision);
174 return new NetconfYangTextSchemaSource(id, sourceIdentifier, schemaString);
177 logger.warn("{}: YANG schema was not successfully retrieved for {}. Errors: {}", id, sourceIdentifier,
180 throw new IllegalStateException(String.format(
181 "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
187 private static class NetconfYangTextSchemaSource extends YangTextSchemaSource {
188 private final RemoteDeviceId id;
189 private final Optional<String> schemaString;
191 public NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sId, final Optional<String> schemaString) {
194 this.schemaString = schemaString;
198 protected MoreObjects.ToStringHelper addToStringAttributes(final MoreObjects.ToStringHelper toStringHelper) {
199 return toStringHelper.add("device", id);
203 public InputStream openStream() throws IOException {
204 return IOUtils.toInputStream(schemaString.get());