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.Charsets;
  15 import com.google.common.base.Function;
  16 import com.google.common.base.MoreObjects;
  17 import com.google.common.base.Optional;
  18 import com.google.common.base.Preconditions;
  19 import com.google.common.util.concurrent.CheckedFuture;
  20 import com.google.common.util.concurrent.Futures;
  21 import com.google.common.util.concurrent.ListenableFuture;
  22 import java.io.ByteArrayInputStream;
  23 import java.io.IOException;
  24 import java.io.InputStream;
  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.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.SchemaSourceException;
  43 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  44 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  45 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48 import org.w3c.dom.Element;
  49
  50 public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSourceProvider<YangTextSchemaSource> {
  51
  52     private static final Logger LOG = LoggerFactory.getLogger(NetconfRemoteSchemaYangSourceProvider.class);
  53
  54     private static final ExceptionMapper<SchemaSourceException> MAPPER = new ExceptionMapper<SchemaSourceException>(
  55             "schemaDownload", SchemaSourceException.class) {
  56         @Override
  57         protected SchemaSourceException newWithCause(final String s, final Throwable throwable) {
  58             return new SchemaSourceException(s, throwable);
  59         }
  60     };
  61
  62     private final DOMRpcService rpc;
  63     private final RemoteDeviceId id;
  64
  65     public NetconfRemoteSchemaYangSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
  66         this.id = id;
  67         this.rpc = Preconditions.checkNotNull(rpc);
  68     }
  69
  70     public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
  71         final QName identifierQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier"));
  72         final YangInstanceIdentifier.NodeIdentifier identifierId = new YangInstanceIdentifier.NodeIdentifier(identifierQName);
  73         final LeafNode<String> identifier = Builders.<String>leafBuilder().withNodeIdentifier(identifierId).withValue(moduleName).build();
  74
  75         final QName formatQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format"));
  76         final YangInstanceIdentifier.NodeIdentifier formatId = new YangInstanceIdentifier.NodeIdentifier(formatQName);
  77         final LeafNode<QName> format = Builders.<QName>leafBuilder().withNodeIdentifier(formatId).withValue(Yang.QNAME).build();
  78
  79         final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> builder = Builders.containerBuilder();
  80
  81         builder.withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.GET_SCHEMA_QNAME))
  82                 .withChild(identifier).withChild(format);
  83
  84         if(revision.isPresent()) {
  85             final QName revisionQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version"));
  86             final YangInstanceIdentifier.NodeIdentifier revisionId = new YangInstanceIdentifier.NodeIdentifier(revisionQName);
  87             final LeafNode<String> revisionNode = Builders.<String>leafBuilder().withNodeIdentifier(revisionId).withValue(revision.get()).build();
  88
  89             builder.withChild(revisionNode);
  90         }
  91
  92         return builder.build();
  93     }
  94
  95     private static Optional<String> getSchemaFromRpc(final RemoteDeviceId id, final NormalizedNode<?, ?> result) {
  96         if (result == null) {
  97             return Optional.absent();
  98         }
  99
 100         final QName schemaWrapperNode = QName.cachedReference(QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()));
 101         final Optional<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> child = ((ContainerNode) result).getChild(toId(schemaWrapperNode));
 102
 103         Preconditions.checkState(child.isPresent() && child.get() instanceof AnyXmlNode,
 104                 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
 105                 schemaWrapperNode, result);
 106
 107         final DOMSource wrappedNode = ((AnyXmlNode) child.get()).getValue();
 108         Preconditions.checkNotNull(wrappedNode.getNode());
 109         final Element dataNode = (Element) wrappedNode.getNode();
 110
 111         return Optional.of(dataNode.getTextContent().trim());
 112     }
 113
 114     @Override
 115     public CheckedFuture<YangTextSchemaSource, SchemaSourceException> getSource(final SourceIdentifier sourceIdentifier) {
 116         final String moduleName = sourceIdentifier.getName();
 117
 118         // If formatted revision is SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION, we have to omit it from request
 119         final String formattedRevision = sourceIdentifier.getRevision().equals(SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION) ? null : sourceIdentifier.getRevision();
 120         final Optional<String> revision = Optional.fromNullable(formattedRevision);
 121         final NormalizedNode<?, ?> getSchemaRequest = createGetSchemaRequest(moduleName, revision);
 122
 123         LOG.trace("{}: Loading YANG schema source for {}:{}", id, moduleName,
 124                 revision);
 125
 126         final ListenableFuture<YangTextSchemaSource> transformed = Futures.transform(
 127                 rpc.invokeRpc(SchemaPath.create(true, NetconfMessageTransformUtil.GET_SCHEMA_QNAME), getSchemaRequest),
 128                 new ResultToYangSourceTransformer(id, sourceIdentifier, moduleName, revision));
 129
 130         final CheckedFuture<YangTextSchemaSource, SchemaSourceException> checked = Futures.makeChecked(transformed, MAPPER);
 131
 132         // / FIXME remove this get, it is only present to wait until source is retrieved
 133         // (goal is to limit concurrent schema download, since NetconfDevice listener does not handle concurrent messages properly)
 134         // TODO retest this
 135         try {
 136             LOG.trace("{}: Blocking for {}", id, sourceIdentifier);
 137             checked.checkedGet();
 138         } catch (final SchemaSourceException e) {
 139             return Futures.immediateFailedCheckedFuture(e);
 140         }
 141
 142         return checked;
 143     }
 144
 145     /**
 146      * Transform composite node to string schema representation and then to ASTSchemaSource
 147      */
 148     private static final class ResultToYangSourceTransformer implements
 149             Function<DOMRpcResult, YangTextSchemaSource> {
 150
 151         private final RemoteDeviceId id;
 152         private final SourceIdentifier sourceIdentifier;
 153         private final String moduleName;
 154         private final Optional<String> revision;
 155
 156         public ResultToYangSourceTransformer(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
 157                 final String moduleName, final Optional<String> revision) {
 158             this.id = id;
 159             this.sourceIdentifier = sourceIdentifier;
 160             this.moduleName = moduleName;
 161             this.revision = revision;
 162         }
 163
 164         @Override
 165         public YangTextSchemaSource apply(final DOMRpcResult input) {
 166
 167             if (input.getErrors().isEmpty()) {
 168
 169                 final Optional<String> schemaString = getSchemaFromRpc(id, input.getResult());
 170
 171                 Preconditions.checkState(schemaString.isPresent(),
 172                         "%s: Unexpected response to get-schema, schema not present in message for: %s", 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     private static class NetconfYangTextSchemaSource extends YangTextSchemaSource {
 191         private final RemoteDeviceId id;
 192         private final Optional<String> schemaString;
 193
 194         public NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sId, final Optional<String> schemaString) {
 195             super(sId);
 196             this.id = id;
 197             this.schemaString = schemaString;
 198         }
 199
 200         @Override
 201         protected MoreObjects.ToStringHelper addToStringAttributes(final MoreObjects.ToStringHelper toStringHelper) {
 202             return toStringHelper.add("device", id);
 203         }
 204
 205         @Override
 206         public InputStream openStream() throws IOException {
 207             return new ByteArrayInputStream(schemaString.get().getBytes(Charsets.UTF_8));
 208         }
 209     }
 210 }