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