opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/schema/mapping/NetconfMessageTransformer.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.mapping;
   9
  10 import com.google.common.base.Optional;
  11
  12 import java.util.List;
  13 import java.util.Set;
  14
  15 import javax.activation.UnsupportedDataTypeException;
  16
  17 import org.opendaylight.controller.netconf.api.NetconfMessage;
  18 import org.opendaylight.controller.sal.connect.api.MessageTransformer;
  19 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
  20 import org.opendaylight.controller.sal.connect.util.MessageCounter;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.common.RpcResult;
  23 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  24 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  25 import org.opendaylight.yangtools.yang.data.impl.CompositeNodeTOImpl;
  26 import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode;
  27 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlCodecProvider;
  28 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
  29 import org.opendaylight.yangtools.yang.data.impl.util.CompositeNodeBuilder;
  30 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  31 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  33 import org.w3c.dom.Document;
  34 import org.w3c.dom.Element;
  35
  36 public class NetconfMessageTransformer implements MessageTransformer<NetconfMessage> {
  37
  38     public static final String MESSAGE_ID_PREFIX = "m";
  39
  40     private Optional<SchemaContext> schemaContext = Optional.absent();
  41     private final MessageCounter counter;
  42
  43     public NetconfMessageTransformer() {
  44         this.counter = new MessageCounter();
  45     }
  46
  47     @Override
  48     public synchronized CompositeNode toNotification(final NetconfMessage message) {
  49         if(schemaContext.isPresent()) {
  50             return toNotification(message, schemaContext.get());
  51         } else {
  52             return XmlDocumentUtils.notificationToDomNodes(message.getDocument(), Optional.<Set<NotificationDefinition>>absent());
  53         }
  54     }
  55
  56     private static CompositeNode toNotification(final NetconfMessage message, final SchemaContext ctx) {
  57         final Set<NotificationDefinition> notifications = ctx.getNotifications();
  58         final Document document = message.getDocument();
  59         return XmlDocumentUtils.notificationToDomNodes(document, Optional.fromNullable(notifications), ctx);
  60     }
  61
  62     @Override
  63     public NetconfMessage toRpcRequest(final QName rpc, final CompositeNode node) {
  64         final CompositeNodeTOImpl rpcPayload = NetconfMessageTransformUtil.wrap(
  65                 NetconfMessageTransformUtil.NETCONF_RPC_QNAME, NetconfMessageTransformUtil.flattenInput(node));
  66         final Document w3cPayload;
  67         try {
  68             final XmlCodecProvider codecProvider = XmlDocumentUtils.defaultValueCodecProvider();
  69             if(schemaContext.isPresent()) {
  70                 if (NetconfMessageTransformUtil.isDataEditOperation(rpc)) {
  71                     final DataNodeContainer schemaForEdit = NetconfMessageTransformUtil.createSchemaForEdit(schemaContext.get());
  72                     w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaForEdit, codecProvider);
  73                 } else {
  74                     // FIXME get and get-config needs schema as well to transform filter using schema context
  75                     // e.g. Identityref nodes in filter fail to serialize properly to xml without schema
  76                     w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaContext.get(), codecProvider);
  77                 }
  78             } else {
  79                 w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, codecProvider);
  80             }
  81         } catch (final UnsupportedDataTypeException e) {
  82             throw new IllegalArgumentException("Unable to create message", e);
  83         }
  84         w3cPayload.getDocumentElement().setAttribute("message-id", counter.getNewMessageId(MESSAGE_ID_PREFIX));
  85         return new NetconfMessage(w3cPayload);
  86     }
  87
  88     @Override
  89     public synchronized RpcResult<CompositeNode> toRpcResult(final NetconfMessage message, final QName rpc) {
  90         if(schemaContext.isPresent()) {
  91             return toRpcResult(message, rpc, schemaContext.get());
  92         } else {
  93             final CompositeNode node = (CompositeNode) XmlDocumentUtils.toDomNode(message.getDocument());
  94             return RpcResultBuilder.success( node ).build();
  95         }
  96     }
  97
  98     private static RpcResult<CompositeNode> toRpcResult(final NetconfMessage message, final QName rpc, final SchemaContext context) {
  99         final CompositeNode compositeNode;
 100
 101         if (NetconfMessageTransformUtil.isDataRetrievalOperation(rpc)) {
 102
 103             final Element xmlData = NetconfMessageTransformUtil.getDataSubtree(message.getDocument());
 104
 105             final List<org.opendaylight.yangtools.yang.data.api.Node<?>> dataNodes = XmlDocumentUtils.toDomNodes(xmlData,
 106                     Optional.of(context.getDataDefinitions()), context);
 107
 108             final CompositeNodeBuilder<ImmutableCompositeNode> it = ImmutableCompositeNode.builder();
 109             it.setQName(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_QNAME);
 110             it.add(ImmutableCompositeNode.create(NetconfMessageTransformUtil.NETCONF_DATA_QNAME, dataNodes));
 111
 112             compositeNode = it.toInstance();
 113         } else {
 114             // TODO map rpc with schema
 115             compositeNode = (CompositeNode) XmlDocumentUtils.toDomNode(message.getDocument());
 116         }
 117
 118         return RpcResultBuilder.success( compositeNode ).build();
 119     }
 120
 121     @Override
 122     public synchronized void onGlobalContextUpdated(final SchemaContext schemaContext) {
 123         this.schemaContext = Optional.of(schemaContext);
 124     }
 125 }