Bump upstreams for Silicon
[netconf.git] / netconf / sal-netconf-connector / src / main / java / org / opendaylight / netconf / sal / connect / netconf / schema / NetconfRemoteSchemaYangSourceProvider.java
1 /*
2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.netconf.sal.connect.netconf.schema;
9
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.util.NetconfUtil.NETCONF_DATA_QNAME;
14
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.ContainerNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
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.repo.api.SourceIdentifier;
39 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
40 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43 import org.w3c.dom.Element;
44
45 public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSourceProvider<YangTextSchemaSource> {
46     private static final Logger LOG = LoggerFactory.getLogger(NetconfRemoteSchemaYangSourceProvider.class);
47     private static final NodeIdentifier FORMAT_PATHARG =
48             NodeIdentifier.create(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format").intern());
49     private static final NodeIdentifier GET_SCHEMA_PATHARG =
50             NodeIdentifier.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME);
51     private static final NodeIdentifier IDENTIFIER_PATHARG =
52             NodeIdentifier.create(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier").intern());
53     private static final NodeIdentifier VERSION_PATHARG =
54             NodeIdentifier.create(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version").intern());
55     private static final LeafNode<?> FORMAT_LEAF =
56             Builders.leafBuilder().withNodeIdentifier(FORMAT_PATHARG).withValue(Yang.QNAME).build();
57     private static final QName NETCONF_DATA =
58             QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()).intern();
59     private static final NodeIdentifier NETCONF_DATA_PATHARG = NodeIdentifier.create(NETCONF_DATA);
60
61     private final DOMRpcService rpc;
62     private final RemoteDeviceId id;
63
64     public NetconfRemoteSchemaYangSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
65         this.id = id;
66         this.rpc = requireNonNull(rpc);
67     }
68
69     public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
70         final LeafNode<?> identifier =
71                 Builders.leafBuilder().withNodeIdentifier(IDENTIFIER_PATHARG).withValue(moduleName).build();
72         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> builder = Builders.containerBuilder()
73                 .withNodeIdentifier(GET_SCHEMA_PATHARG).withChild(identifier).withChild(FORMAT_LEAF);
74
75         if (revision.isPresent()) {
76             builder.withChild(Builders.leafBuilder()
77                     .withNodeIdentifier(VERSION_PATHARG).withValue(revision.get()).build());
78         }
79
80         return builder.build();
81     }
82
83     private static Optional<String> getSchemaFromRpc(final RemoteDeviceId id, final NormalizedNode<?, ?> result) {
84         if (result == null) {
85             return Optional.empty();
86         }
87
88         final Optional<DataContainerChild<?, ?>> child = ((ContainerNode) result).getChild(NETCONF_DATA_PATHARG);
89         checkState(child.isPresent() && child.get() instanceof DOMSourceAnyxmlNode,
90                 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
91                 NETCONF_DATA, result);
92
93         final DOMSource wrappedNode = ((DOMSourceAnyxmlNode) child.get()).getValue();
94         final Element dataNode = (Element) requireNonNull(wrappedNode.getNode());
95
96         return Optional.of(dataNode.getTextContent().trim());
97     }
98
99     @Override
100     public ListenableFuture<YangTextSchemaSource> getSource(final SourceIdentifier sourceIdentifier) {
101         final String moduleName = sourceIdentifier.getName();
102
103         final Optional<String> revision = sourceIdentifier.getRevision().map(Revision::toString);
104         final ContainerNode getSchemaRequest = createGetSchemaRequest(moduleName, revision);
105         LOG.trace("{}: Loading YANG schema source for {}:{}", id, moduleName, revision);
106         return Futures.transform(
107             rpc.invokeRpc(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, getSchemaRequest), input -> {
108                 // Transform composite node to string schema representation and then to ASTSchemaSource.
109                 if (input.getErrors().isEmpty()) {
110                     final Optional<String> schemaString = getSchemaFromRpc(id, input.getResult());
111                     checkState(schemaString.isPresent(),
112                         "%s: Unexpected response to get-schema, schema not present in message for: %s", id,
113                         sourceIdentifier);
114                     LOG.debug("{}: YANG Schema successfully retrieved for {}:{}", id, moduleName, revision);
115                     return new NetconfYangTextSchemaSource(id, sourceIdentifier, schemaString);
116                 }
117
118                 LOG.warn("{}: YANG schema was not successfully retrieved for {}. Errors: {}", id, sourceIdentifier,
119                     input.getErrors());
120                 throw new IllegalStateException(String.format(
121                     "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
122                     input.getErrors()));
123             }, MoreExecutors.directExecutor());
124     }
125
126     static class NetconfYangTextSchemaSource extends YangTextSchemaSource {
127         private final RemoteDeviceId id;
128         private final Optional<String> schemaString;
129
130         NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
131                 final Optional<String> schemaString) {
132             super(sourceIdentifier);
133             this.id = id;
134             this.schemaString = schemaString;
135         }
136
137         @Override
138         protected MoreObjects.ToStringHelper addToStringAttributes(final MoreObjects.ToStringHelper toStringHelper) {
139             return toStringHelper.add("device", id);
140         }
141
142         @Override
143         public InputStream openStream() {
144             return new ByteArrayInputStream(schemaString.get().getBytes(StandardCharsets.UTF_8));
145         }
146     }
147 }