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.CheckedFuture;
  19 import com.google.common.util.concurrent.Futures;
  20 import com.google.common.util.concurrent.ListenableFuture;
  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.util.concurrent.ExceptionMapper;
  32 import org.opendaylight.yangtools.yang.common.QName;
  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.SchemaSourceException;
  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 static final ExceptionMapper<SchemaSourceException> MAPPER = new ExceptionMapper<SchemaSourceException>(
  56             "schemaDownload", SchemaSourceException.class) {
  57         @Override
  58         protected SchemaSourceException newWithCause(final String s, final Throwable throwable) {
  59             return new SchemaSourceException(s, throwable);
  60         }
  61     };
  62
  63     private final DOMRpcService rpc;
  64     private final RemoteDeviceId id;
  65
  66     public NetconfRemoteSchemaYangSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
  67         this.id = id;
  68         this.rpc = Preconditions.checkNotNull(rpc);
  69     }
  70
  71     private static final NodeIdentifier FORMAT_PATHARG = new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format").intern());
  72     private static final NodeIdentifier GET_SCHEMA_PATHARG = new NodeIdentifier(NetconfMessageTransformUtil.GET_SCHEMA_QNAME);
  73     private static final NodeIdentifier IDENTIFIER_PATHARG = new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier").intern());
  74     private static final NodeIdentifier VERSION_PATHARG = new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version").intern());
  75
  76     private static final LeafNode<?> FORMAT_LEAF = Builders.leafBuilder().withNodeIdentifier(FORMAT_PATHARG).withValue(Yang.QNAME).build();
  77
  78     private static final QName NETCONF_DATA = QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()).intern();
  79     private static final NodeIdentifier NETCONF_DATA_PATHARG = toId(NETCONF_DATA);
  80
  81     public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
  82         final LeafNode<?> identifier = Builders.leafBuilder().withNodeIdentifier(IDENTIFIER_PATHARG).withValue(moduleName).build();
  83         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> builder = Builders.containerBuilder()
  84                 .withNodeIdentifier(GET_SCHEMA_PATHARG).withChild(identifier).withChild(FORMAT_LEAF);
  85
  86         if (revision.isPresent()) {
  87             builder.withChild(Builders.leafBuilder().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 Optional<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> child = ((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 CheckedFuture<YangTextSchemaSource, SchemaSourceException> getSource(final SourceIdentifier sourceIdentifier) {
 113         final String moduleName = sourceIdentifier.getName();
 114
 115         // If formatted revision is SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION, we have to omit it from request
 116         final String badRev = sourceIdentifier.getRevision();
 117         final String formattedRevision = SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION.equals(badRev) ? null : badRev;
 118         final Optional<String> revision = Optional.fromNullable(formattedRevision);
 119         final NormalizedNode<?, ?> getSchemaRequest = createGetSchemaRequest(moduleName, revision);
 120
 121         LOG.trace("{}: Loading YANG schema source for {}:{}", id, moduleName,
 122                 revision);
 123
 124         final ListenableFuture<YangTextSchemaSource> transformed = Futures.transform(
 125                 rpc.invokeRpc(SchemaPath.create(true, NetconfMessageTransformUtil.GET_SCHEMA_QNAME), getSchemaRequest),
 126                 new ResultToYangSourceTransformer(id, sourceIdentifier, moduleName, revision));
 127
 128         final CheckedFuture<YangTextSchemaSource, SchemaSourceException> checked = Futures.makeChecked(transformed, MAPPER);
 129
 130         return checked;
 131     }
 132
 133     /**
 134      * Transform composite node to string schema representation and then to ASTSchemaSource
 135      */
 136     private static final class ResultToYangSourceTransformer implements
 137             Function<DOMRpcResult, YangTextSchemaSource> {
 138
 139         private final RemoteDeviceId id;
 140         private final SourceIdentifier sourceIdentifier;
 141         private final String moduleName;
 142         private final Optional<String> revision;
 143
 144         public ResultToYangSourceTransformer(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
 145                 final String moduleName, final Optional<String> revision) {
 146             this.id = id;
 147             this.sourceIdentifier = sourceIdentifier;
 148             this.moduleName = moduleName;
 149             this.revision = revision;
 150         }
 151
 152         @Override
 153         public YangTextSchemaSource apply(final DOMRpcResult input) {
 154
 155             if (input.getErrors().isEmpty()) {
 156
 157                 final Optional<String> schemaString = getSchemaFromRpc(id, input.getResult());
 158
 159                 Preconditions.checkState(schemaString.isPresent(),
 160                         "%s: Unexpected response to get-schema, schema not present in message for: %s", id, sourceIdentifier);
 161
 162                 LOG.debug("{}: YANG Schema successfully retrieved for {}:{}",
 163                         id, moduleName, revision);
 164                 return new NetconfYangTextSchemaSource(id, sourceIdentifier, schemaString);
 165             }
 166
 167             LOG.warn(
 168                     "{}: YANG schema was not successfully retrieved for {}. Errors: {}",
 169                     id, sourceIdentifier, input.getErrors());
 170
 171             throw new IllegalStateException(String.format(
 172                     "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
 173                     input.getErrors()));
 174         }
 175
 176     }
 177
 178     static class NetconfYangTextSchemaSource extends YangTextSchemaSource {
 179         private final RemoteDeviceId id;
 180         private final Optional<String> schemaString;
 181
 182         public NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sId, final Optional<String> schemaString) {
 183             super(sId);
 184             this.id = id;
 185             this.schemaString = schemaString;
 186         }
 187
 188         @Override
 189         protected MoreObjects.ToStringHelper addToStringAttributes(final MoreObjects.ToStringHelper toStringHelper) {
 190             return toStringHelper.add("device", id);
 191         }
 192
 193         @Override
 194         public InputStream openStream() throws IOException {
 195             return new ByteArrayInputStream(schemaString.get().getBytes(StandardCharsets.UTF_8));
 196         }
 197     }
 198 }