opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/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.controller.sal.connect.netconf.schema;
   9
  10 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.GET_SCHEMA_QNAME;
  11 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DATA_QNAME;
  12 import static org.opendaylight.controller.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.IOException;
  22 import java.io.InputStream;
  23 import javax.xml.transform.dom.DOMSource;
  24 import org.apache.commons.io.IOUtils;
  25 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  26 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  27 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
  28 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
  29 import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
  30 import org.opendaylight.yangtools.yang.common.QName;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  32 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  35 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  39 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  40 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException;
  41 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  42 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  43 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46 import org.w3c.dom.Element;
  47
  48 public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSourceProvider<YangTextSchemaSource> {
  49
  50     private static final Logger logger = LoggerFactory.getLogger(NetconfRemoteSchemaYangSourceProvider.class);
  51
  52     private static final ExceptionMapper<SchemaSourceException> MAPPER = new ExceptionMapper<SchemaSourceException>(
  53             "schemaDownload", SchemaSourceException.class) {
  54         @Override
  55         protected SchemaSourceException newWithCause(final String s, final Throwable throwable) {
  56             return new SchemaSourceException(s, throwable);
  57         }
  58     };
  59
  60     private final DOMRpcService rpc;
  61     private final RemoteDeviceId id;
  62
  63     public NetconfRemoteSchemaYangSourceProvider(final RemoteDeviceId id, final DOMRpcService rpc) {
  64         this.id = id;
  65         this.rpc = Preconditions.checkNotNull(rpc);
  66     }
  67
  68     public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
  69         final QName identifierQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier"));
  70         final YangInstanceIdentifier.NodeIdentifier identifierId = new YangInstanceIdentifier.NodeIdentifier(identifierQName);
  71         final LeafNode<String> identifier = Builders.<String>leafBuilder().withNodeIdentifier(identifierId).withValue(moduleName).build();
  72
  73         final QName formatQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format"));
  74         final YangInstanceIdentifier.NodeIdentifier formatId = new YangInstanceIdentifier.NodeIdentifier(formatQName);
  75         final LeafNode<String> format = Builders.<String>leafBuilder().withNodeIdentifier(formatId).withValue("yang").build();
  76
  77         final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> builder = Builders.containerBuilder();
  78
  79         builder.withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.GET_SCHEMA_QNAME))
  80         .withChild(identifier)
  81         .withChild(format);
  82
  83         if(revision.isPresent()) {
  84             final QName revisionQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version"));
  85             final YangInstanceIdentifier.NodeIdentifier revisionId = new YangInstanceIdentifier.NodeIdentifier(revisionQName);
  86             final LeafNode<String> revisionNode = Builders.<String>leafBuilder().withNodeIdentifier(revisionId).withValue(revision.get()).build();
  87
  88             builder.withChild(revisionNode);
  89         }
  90
  91         return builder.build();
  92     }
  93
  94     private static Optional<String> getSchemaFromRpc(final RemoteDeviceId id, final NormalizedNode<?, ?> result) {
  95         if (result == null) {
  96             return Optional.absent();
  97         }
  98
  99         final QName schemaWrapperNode = QName.cachedReference(QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()));
 100         final Optional<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> child = ((ContainerNode) result).getChild(toId(schemaWrapperNode));
 101
 102         Preconditions.checkState(child.isPresent() && child.get() instanceof AnyXmlNode,
 103                 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
 104                 schemaWrapperNode, result);
 105
 106         final DOMSource wrappedNode = ((AnyXmlNode) child.get()).getValue();
 107         Preconditions.checkNotNull(wrappedNode.getNode());
 108         final Element dataNode = (Element) wrappedNode.getNode();
 109
 110         return Optional.of(dataNode.getTextContent().trim());
 111     }
 112
 113     @Override
 114     public CheckedFuture<YangTextSchemaSource, SchemaSourceException> getSource(final SourceIdentifier sourceIdentifier) {
 115         final String moduleName = sourceIdentifier.getName();
 116
 117         // If formatted revision is SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION, we have to omit it from request
 118         final String formattedRevision = sourceIdentifier.getRevision().equals(SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION) ? null : sourceIdentifier.getRevision();
 119         final Optional<String> revision = Optional.fromNullable(formattedRevision);
 120         final NormalizedNode<?, ?> getSchemaRequest = createGetSchemaRequest(moduleName, revision);
 121
 122         logger.trace("{}: Loading YANG schema source for {}:{}", id, moduleName, 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         // / FIXME remove this get, it is only present to wait until source is retrieved
 131         // (goal is to limit concurrent schema download, since NetconfDevice listener does not handle concurrent messages properly)
 132         // TODO retest this
 133         try {
 134             logger.trace("{}: Blocking for {}", id, sourceIdentifier);
 135             checked.checkedGet();
 136         } catch (final SchemaSourceException e) {
 137             return Futures.immediateFailedCheckedFuture(e);
 138         }
 139
 140         return checked;
 141     }
 142
 143     /**
 144      * Transform composite node to string schema representation and then to ASTSchemaSource
 145      */
 146     private static final class ResultToYangSourceTransformer implements
 147             Function<DOMRpcResult, YangTextSchemaSource> {
 148
 149         private final RemoteDeviceId id;
 150         private final SourceIdentifier sourceIdentifier;
 151         private final String moduleName;
 152         private final Optional<String> revision;
 153
 154         public ResultToYangSourceTransformer(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
 155                 final String moduleName, final Optional<String> revision) {
 156             this.id = id;
 157             this.sourceIdentifier = sourceIdentifier;
 158             this.moduleName = moduleName;
 159             this.revision = revision;
 160         }
 161
 162         @Override
 163         public YangTextSchemaSource apply(final DOMRpcResult input) {
 164
 165             if (input.getErrors().isEmpty()) {
 166
 167                 final Optional<String> schemaString = getSchemaFromRpc(id, input.getResult());
 168
 169                 Preconditions.checkState(schemaString.isPresent(),
 170                         "%s: Unexpected response to get-schema, schema not present in message for: %s", id, sourceIdentifier);
 171
 172                 logger.debug("{}: YANG Schema successfully retrieved for {}:{}", id, moduleName, revision);
 173                 return new NetconfYangTextSchemaSource(id, sourceIdentifier, schemaString);
 174             }
 175
 176             logger.warn("{}: YANG schema was not successfully retrieved for {}. Errors: {}", id, sourceIdentifier,
 177                     input.getErrors());
 178
 179             throw new IllegalStateException(String.format(
 180                     "%s: YANG schema was not successfully retrieved for %s. Errors: %s", id, sourceIdentifier,
 181                     input.getErrors()));
 182         }
 183
 184     }
 185
 186     private static class NetconfYangTextSchemaSource extends YangTextSchemaSource {
 187         private final RemoteDeviceId id;
 188         private final Optional<String> schemaString;
 189
 190         public NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sId, final Optional<String> schemaString) {
 191             super(sId);
 192             this.id = id;
 193             this.schemaString = schemaString;
 194         }
 195
 196         @Override
 197         protected MoreObjects.ToStringHelper addToStringAttributes(final MoreObjects.ToStringHelper toStringHelper) {
 198             return toStringHelper.add("device", id);
 199         }
 200
 201         @Override
 202         public InputStream openStream() throws IOException {
 203             return IOUtils.toInputStream(schemaString.get());
 204         }
 205     }
 206 }