plugins/netconf-client-mdsal/src/main/java/org/opendaylight/netconf/client/mdsal/MonitoringSchemaSourceProvider.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.client.mdsal;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.MoreExecutors;
  16 import java.util.Optional;
  17 import javax.xml.transform.dom.DOMSource;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  20 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceId;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.GetSchema;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.get.schema.output.Data;
  24 import org.opendaylight.yangtools.yang.common.QName;
  25 import org.opendaylight.yangtools.yang.common.Revision;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  27 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  30 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  32 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  33 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
  34 import org.opendaylight.yangtools.yang.model.api.source.YangTextSource;
  35 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38 import org.w3c.dom.Element;
  39
  40 /**
  41  * A {@link SchemaSourceProvider} producing {@link YangTextSource}s based on a device's
  42  * {@code ietf-netconf-monitoring} interface. The set of available sources is not pre-determined and each request is
  43  * dispatched to the device, i.e. this provider reflects real-time updates to available schemas.
  44  */
  45 public final class MonitoringSchemaSourceProvider implements SchemaSourceProvider<YangTextSource> {
  46     private static final Logger LOG = LoggerFactory.getLogger(MonitoringSchemaSourceProvider.class);
  47     private static final NodeIdentifier FORMAT_PATHARG =
  48             NodeIdentifier.create(QName.create(GetSchema.QNAME, "format").intern());
  49     private static final NodeIdentifier GET_SCHEMA_PATHARG = NodeIdentifier.create(GetSchema.QNAME);
  50     private static final NodeIdentifier IDENTIFIER_PATHARG =
  51             NodeIdentifier.create(QName.create(GetSchema.QNAME, "identifier").intern());
  52     private static final NodeIdentifier VERSION_PATHARG =
  53             NodeIdentifier.create(QName.create(GetSchema.QNAME, "version").intern());
  54     private static final LeafNode<?> FORMAT_LEAF =
  55             Builders.leafBuilder().withNodeIdentifier(FORMAT_PATHARG).withValue(Yang.QNAME).build();
  56     private static final NodeIdentifier NETCONF_DATA_PATHARG = NodeIdentifier.create(Data.QNAME);
  57
  58     private final DOMRpcService rpc;
  59     private final RemoteDeviceId id;
  60
  61     public MonitoringSchemaSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
  62         this.id = requireNonNull(id);
  63         this.rpc = requireNonNull(rpc);
  64     }
  65
  66     public static @NonNull ContainerNode createGetSchemaRequest(final String moduleName,
  67             final Optional<String> revision) {
  68         final var builder = Builders.containerBuilder()
  69             .withNodeIdentifier(GET_SCHEMA_PATHARG)
  70             .withChild(ImmutableNodes.leafNode(IDENTIFIER_PATHARG, moduleName))
  71             .withChild(FORMAT_LEAF);
  72         revision.ifPresent(rev -> builder.withChild(ImmutableNodes.leafNode(VERSION_PATHARG, rev)));
  73         return builder.build();
  74     }
  75
  76     private static Optional<String> getSchemaFromRpc(final RemoteDeviceId id, final ContainerNode result) {
  77         if (result == null) {
  78             return Optional.empty();
  79         }
  80
  81         final DataContainerChild child = result.childByArg(NETCONF_DATA_PATHARG);
  82         checkState(child instanceof DOMSourceAnyxmlNode,
  83                 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
  84                 Data.QNAME, result);
  85
  86         final DOMSource wrappedNode = ((DOMSourceAnyxmlNode) child).body();
  87         final Element dataNode = (Element) requireNonNull(wrappedNode.getNode());
  88
  89         return Optional.of(dataNode.getTextContent().trim());
  90     }
  91
  92     @Override
  93     public ListenableFuture<YangTextSource> getSource(final SourceIdentifier sourceIdentifier) {
  94         final String moduleName = sourceIdentifier.name().getLocalName();
  95
  96         final Optional<String> revision = Optional.ofNullable(sourceIdentifier.revision()).map(Revision::toString);
  97         final ContainerNode getSchemaRequest = createGetSchemaRequest(moduleName, revision);
  98         LOG.trace("{}: Loading YANG schema source for {}:{}", id, moduleName, revision);
  99         return Futures.transform(
 100             rpc.invokeRpc(GetSchema.QNAME, getSchemaRequest), result -> {
 101                 // Transform composite node to string schema representation and then to ASTSchemaSource.
 102                 if (result.errors().isEmpty()) {
 103                     final String schemaString = getSchemaFromRpc(id, result.value())
 104                         .orElseThrow(() -> new IllegalStateException(
 105                             id + ": Unexpected response to get-schema, schema not present in message for: "
 106                                 + sourceIdentifier));
 107                     LOG.debug("{}: YANG Schema successfully retrieved for {}:{}", id, moduleName, revision);
 108                     return new CachedYangTextSchemaSource(id, sourceIdentifier, moduleName, schemaString);
 109                 }
 110
 111                 LOG.warn("{}: YANG schema was not successfully retrieved for {}. Errors: {}", id, sourceIdentifier,
 112                     result.errors());
 113                 throw new IllegalStateException(String.format(
 114                     "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
 115                     result.errors()));
 116             }, MoreExecutors.directExecutor());
 117     }
 118 }