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