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