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.eclipse.jdt.annotation.NonNull;
  25 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  26 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  27 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
  29 import org.opendaylight.yangtools.yang.common.QName;
  30 import org.opendaylight.yangtools.yang.common.Revision;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  32 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  35 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  40 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  41 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  42 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45 import org.w3c.dom.Element;
  46
  47 public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSourceProvider<YangTextSchemaSource> {
  48     private static final Logger LOG = LoggerFactory.getLogger(NetconfRemoteSchemaYangSourceProvider.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);
  62
  63     private final DOMRpcService rpc;
  64     private final RemoteDeviceId id;
  65
  66     public NetconfRemoteSchemaYangSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
  67         this.id = id;
  68         this.rpc = requireNonNull(rpc);
  69     }
  70
  71     public static @NonNull ContainerNode createGetSchemaRequest(final String moduleName,
  72             final Optional<String> revision) {
  73         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> builder = Builders.containerBuilder()
  74                 .withNodeIdentifier(GET_SCHEMA_PATHARG)
  75                 .withChild(ImmutableNodes.leafNode(IDENTIFIER_PATHARG, moduleName))
  76                 .withChild(FORMAT_LEAF);
  77         if (revision.isPresent()) {
  78             builder.withChild(ImmutableNodes.leafNode(VERSION_PATHARG, revision.get()));
  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).findChildByArg(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()).body();
  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, moduleName,
 116                         schemaString.get().getBytes(StandardCharsets.UTF_8));
 117                 }
 118
 119                 LOG.warn("{}: YANG schema was not successfully retrieved for {}. Errors: {}", id, sourceIdentifier,
 120                     input.getErrors());
 121                 throw new IllegalStateException(String.format(
 122                     "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
 123                     input.getErrors()));
 124             }, MoreExecutors.directExecutor());
 125     }
 126
 127     static class NetconfYangTextSchemaSource extends YangTextSchemaSource {
 128         private final RemoteDeviceId id;
 129         private final byte[] schemaBytes;
 130         private final String symbolicName;
 131
 132         NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
 133                 final String symbolicName, final byte[] schemaBytes) {
 134             super(sourceIdentifier);
 135             this.symbolicName = requireNonNull(symbolicName);
 136             this.id = id;
 137             this.schemaBytes = schemaBytes.clone();
 138         }
 139
 140         @Override
 141         protected MoreObjects.ToStringHelper addToStringAttributes(final MoreObjects.ToStringHelper toStringHelper) {
 142             return toStringHelper.add("device", id);
 143         }
 144
 145         @Override
 146         public InputStream openStream() {
 147             return new ByteArrayInputStream(schemaBytes);
 148         }
 149
 150         @Override
 151         public Optional<String> getSymbolicName() {
 152             return Optional.of(symbolicName);
 153         }
 154     }
 155 }