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 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;
  13
  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.Futures;
  19 import com.google.common.util.concurrent.ListenableFuture;
  20 import com.google.common.util.concurrent.MoreExecutors;
  21 import java.io.ByteArrayInputStream;
  22 import java.io.IOException;
  23 import java.io.InputStream;
  24 import java.nio.charset.StandardCharsets;
  25 import javax.annotation.Nonnull;
  26 import javax.xml.transform.dom.DOMSource;
  27 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  28 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  29 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  30 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
  32 import org.opendaylight.yangtools.yang.common.QName;
  33 import org.opendaylight.yangtools.yang.common.Revision;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  36 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  39 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  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;
  50
  51 public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSourceProvider<YangTextSchemaSource> {
  52
  53     private static final Logger LOG = LoggerFactory.getLogger(NetconfRemoteSchemaYangSourceProvider.class);
  54
  55     private final DOMRpcService rpc;
  56     private final RemoteDeviceId id;
  57
  58     public NetconfRemoteSchemaYangSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
  59         this.id = id;
  60         this.rpc = Preconditions.checkNotNull(rpc);
  61     }
  62
  63     private static final NodeIdentifier FORMAT_PATHARG =
  64             new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format").intern());
  65     private static final NodeIdentifier GET_SCHEMA_PATHARG =
  66             new NodeIdentifier(NetconfMessageTransformUtil.GET_SCHEMA_QNAME);
  67     private static final NodeIdentifier IDENTIFIER_PATHARG =
  68             new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier").intern());
  69     private static final NodeIdentifier VERSION_PATHARG =
  70             new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version").intern());
  71
  72     private static final LeafNode<?> FORMAT_LEAF =
  73             Builders.leafBuilder().withNodeIdentifier(FORMAT_PATHARG).withValue(Yang.QNAME).build();
  74
  75     private static final QName NETCONF_DATA =
  76             QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()).intern();
  77     private static final NodeIdentifier NETCONF_DATA_PATHARG = toId(NETCONF_DATA);
  78
  79     public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
  80         final LeafNode<?> identifier =
  81                 Builders.leafBuilder().withNodeIdentifier(IDENTIFIER_PATHARG).withValue(moduleName).build();
  82         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> builder = Builders.containerBuilder()
  83                 .withNodeIdentifier(GET_SCHEMA_PATHARG).withChild(identifier).withChild(FORMAT_LEAF);
  84
  85         if (revision.isPresent()) {
  86             builder.withChild(Builders.leafBuilder()
  87                     .withNodeIdentifier(VERSION_PATHARG).withValue(revision.get()).build());
  88         }
  89
  90         return builder.build();
  91     }
  92
  93     private static Optional<String> getSchemaFromRpc(final RemoteDeviceId id, final NormalizedNode<?, ?> result) {
  94         if (result == null) {
  95             return Optional.absent();
  96         }
  97
  98         final java.util.Optional<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> child =
  99                 ((ContainerNode) result).getChild(NETCONF_DATA_PATHARG);
 100
 101         Preconditions.checkState(child.isPresent() && child.get() instanceof AnyXmlNode,
 102                 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
 103                 NETCONF_DATA, result);
 104
 105         final DOMSource wrappedNode = ((AnyXmlNode) child.get()).getValue();
 106         Preconditions.checkNotNull(wrappedNode.getNode());
 107         final Element dataNode = (Element) wrappedNode.getNode();
 108
 109         return Optional.of(dataNode.getTextContent().trim());
 110     }
 111
 112     @Override
 113     public ListenableFuture<YangTextSchemaSource> getSource(final SourceIdentifier sourceIdentifier) {
 114         final String moduleName = sourceIdentifier.getName();
 115
 116         final Optional<String> revision = Optional.fromJavaUtil(sourceIdentifier.getRevision().map(Revision::toString));
 117         final NormalizedNode<?, ?> getSchemaRequest = createGetSchemaRequest(moduleName, revision);
 118
 119         LOG.trace("{}: Loading YANG schema source for {}:{}", id, moduleName,
 120                 revision);
 121
 122         return Futures.transform(
 123             rpc.invokeRpc(SchemaPath.create(true, NetconfMessageTransformUtil.GET_SCHEMA_QNAME), getSchemaRequest),
 124                 new ResultToYangSourceTransformer(id, sourceIdentifier, moduleName, revision),
 125                 MoreExecutors.directExecutor());
 126     }
 127
 128     /**
 129      * Transform composite node to string schema representation and then to ASTSchemaSource.
 130      */
 131     private static final class ResultToYangSourceTransformer implements
 132             Function<DOMRpcResult, YangTextSchemaSource> {
 133
 134         private final RemoteDeviceId id;
 135         private final SourceIdentifier sourceIdentifier;
 136         private final String moduleName;
 137         private final Optional<String> revision;
 138
 139         ResultToYangSourceTransformer(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
 140                 final String moduleName, final Optional<String> revision) {
 141             this.id = id;
 142             this.sourceIdentifier = sourceIdentifier;
 143             this.moduleName = moduleName;
 144             this.revision = revision;
 145         }
 146
 147         @Override
 148         public YangTextSchemaSource apply(@Nonnull final DOMRpcResult input) {
 149
 150             if (input.getErrors().isEmpty()) {
 151
 152                 final Optional<String> schemaString = getSchemaFromRpc(id, input.getResult());
 153
 154                 Preconditions.checkState(schemaString.isPresent(),
 155                         "%s: Unexpected response to get-schema, schema not present in message for: %s",
 156                         id, sourceIdentifier);
 157
 158                 LOG.debug("{}: YANG Schema successfully retrieved for {}:{}",
 159                         id, moduleName, revision);
 160                 return new NetconfYangTextSchemaSource(id, sourceIdentifier, schemaString);
 161             }
 162
 163             LOG.warn(
 164                     "{}: YANG schema was not successfully retrieved for {}. Errors: {}",
 165                     id, sourceIdentifier, input.getErrors());
 166
 167             throw new IllegalStateException(String.format(
 168                     "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
 169                     input.getErrors()));
 170         }
 171
 172     }
 173
 174     static class NetconfYangTextSchemaSource extends YangTextSchemaSource {
 175         private final RemoteDeviceId id;
 176         private final Optional<String> schemaString;
 177
 178         NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
 179                                            final Optional<String> schemaString) {
 180             super(sourceIdentifier);
 181             this.id = id;
 182             this.schemaString = schemaString;
 183         }
 184
 185         @Override
 186         protected MoreObjects.ToStringHelper addToStringAttributes(final MoreObjects.ToStringHelper toStringHelper) {
 187             return toStringHelper.add("device", id);
 188         }
 189
 190         @Override
 191         public InputStream openStream() throws IOException {
 192             return new ByteArrayInputStream(schemaString.get().getBytes(StandardCharsets.UTF_8));
 193         }
 194     }
 195 }