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 message, final Throwable throwable) {
  59             return new SchemaSourceException(message, 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 =
  72             new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format").intern());
  73     private static final NodeIdentifier GET_SCHEMA_PATHARG =
  74             new NodeIdentifier(NetconfMessageTransformUtil.GET_SCHEMA_QNAME);
  75     private static final NodeIdentifier IDENTIFIER_PATHARG =
  76             new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier").intern());
  77     private static final NodeIdentifier VERSION_PATHARG =
  78             new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version").intern());
  79
  80     private static final LeafNode<?> FORMAT_LEAF =
  81             Builders.leafBuilder().withNodeIdentifier(FORMAT_PATHARG).withValue(Yang.QNAME).build();
  82
  83     private static final QName NETCONF_DATA =
  84             QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()).intern();
  85     private static final NodeIdentifier NETCONF_DATA_PATHARG = toId(NETCONF_DATA);
  86
  87     public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
  88         final LeafNode<?> identifier =
  89                 Builders.leafBuilder().withNodeIdentifier(IDENTIFIER_PATHARG).withValue(moduleName).build();
  90         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> builder = Builders.containerBuilder()
  91                 .withNodeIdentifier(GET_SCHEMA_PATHARG).withChild(identifier).withChild(FORMAT_LEAF);
  92
  93         if (revision.isPresent()) {
  94             builder.withChild(Builders.leafBuilder()
  95                     .withNodeIdentifier(VERSION_PATHARG).withValue(revision.get()).build());
  96         }
  97
  98         return builder.build();
  99     }
 100
 101     private static Optional<String> getSchemaFromRpc(final RemoteDeviceId id, final NormalizedNode<?, ?> result) {
 102         if (result == null) {
 103             return Optional.absent();
 104         }
 105
 106         final Optional<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> child =
 107                 ((ContainerNode) result).getChild(NETCONF_DATA_PATHARG);
 108
 109         Preconditions.checkState(child.isPresent() && child.get() instanceof AnyXmlNode,
 110                 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
 111                 NETCONF_DATA, result);
 112
 113         final DOMSource wrappedNode = ((AnyXmlNode) child.get()).getValue();
 114         Preconditions.checkNotNull(wrappedNode.getNode());
 115         final Element dataNode = (Element) wrappedNode.getNode();
 116
 117         return Optional.of(dataNode.getTextContent().trim());
 118     }
 119
 120     @Override
 121     public CheckedFuture<YangTextSchemaSource, SchemaSourceException> getSource(
 122             final SourceIdentifier sourceIdentifier) {
 123         final String moduleName = sourceIdentifier.getName();
 124
 125         // If formatted revision is SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION, we have to omit it from request
 126         final String badRev = sourceIdentifier.getRevision();
 127         final String formattedRevision = SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION.equals(badRev) ? null : badRev;
 128         final Optional<String> revision = Optional.fromNullable(formattedRevision);
 129         final NormalizedNode<?, ?> getSchemaRequest = createGetSchemaRequest(moduleName, revision);
 130
 131         LOG.trace("{}: Loading YANG schema source for {}:{}", id, moduleName,
 132                 revision);
 133
 134         final ListenableFuture<YangTextSchemaSource> transformed = Futures.transform(
 135                 rpc.invokeRpc(SchemaPath.create(true, NetconfMessageTransformUtil.GET_SCHEMA_QNAME), getSchemaRequest),
 136                 new ResultToYangSourceTransformer(id, sourceIdentifier, moduleName, revision));
 137
 138         final CheckedFuture<YangTextSchemaSource, SchemaSourceException> checked =
 139                 Futures.makeChecked(transformed, MAPPER);
 140
 141         return checked;
 142     }
 143
 144     /**
 145      * Transform composite node to string schema representation and then to ASTSchemaSource.
 146      */
 147     private static final class ResultToYangSourceTransformer implements
 148             Function<DOMRpcResult, YangTextSchemaSource> {
 149
 150         private final RemoteDeviceId id;
 151         private final SourceIdentifier sourceIdentifier;
 152         private final String moduleName;
 153         private final Optional<String> revision;
 154
 155         ResultToYangSourceTransformer(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
 156                 final String moduleName, final Optional<String> revision) {
 157             this.id = id;
 158             this.sourceIdentifier = sourceIdentifier;
 159             this.moduleName = moduleName;
 160             this.revision = revision;
 161         }
 162
 163         @Override
 164         public YangTextSchemaSource apply(final DOMRpcResult input) {
 165
 166             if (input.getErrors().isEmpty()) {
 167
 168                 final Optional<String> schemaString = getSchemaFromRpc(id, input.getResult());
 169
 170                 Preconditions.checkState(schemaString.isPresent(),
 171                         "%s: Unexpected response to get-schema, schema not present in message for: %s",
 172                         id, sourceIdentifier);
 173
 174                 LOG.debug("{}: YANG Schema successfully retrieved for {}:{}",
 175                         id, moduleName, revision);
 176                 return new NetconfYangTextSchemaSource(id, sourceIdentifier, schemaString);
 177             }
 178
 179             LOG.warn(
 180                     "{}: YANG schema was not successfully retrieved for {}. Errors: {}",
 181                     id, sourceIdentifier, input.getErrors());
 182
 183             throw new IllegalStateException(String.format(
 184                     "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
 185                     input.getErrors()));
 186         }
 187
 188     }
 189
 190     static class NetconfYangTextSchemaSource extends YangTextSchemaSource {
 191         private final RemoteDeviceId id;
 192         private final Optional<String> schemaString;
 193
 194         NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
 195                                            final Optional<String> schemaString) {
 196             super(sourceIdentifier);
 197             this.id = id;
 198             this.schemaString = schemaString;
 199         }
 200
 201         @Override
 202         protected MoreObjects.ToStringHelper addToStringAttributes(final MoreObjects.ToStringHelper toStringHelper) {
 203             return toStringHelper.add("device", id);
 204         }
 205
 206         @Override
 207         public InputStream openStream() throws IOException {
 208             return new ByteArrayInputStream(schemaString.get().getBytes(StandardCharsets.UTF_8));
 209         }
 210     }
 211 }