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