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 if (NetconfMessageTransformUtil.isGetOperation(rpc)) {
  74                     final DataNodeContainer schemaForGet = NetconfMessageTransformUtil.createSchemaForGet(schemaContext.get());
  75                     w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaForGet, codecProvider);
  76                 } else if (NetconfMessageTransformUtil.isGetConfigOperation(rpc)) {
  77                     final DataNodeContainer schemaForGetConfig = NetconfMessageTransformUtil.createSchemaForGetConfig(schemaContext.get());
  78                     w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaForGetConfig, codecProvider);
  79                 } else {
  80                     final DataNodeContainer schemaForGetConfig = NetconfMessageTransformUtil.createSchemaForRpc(rpc, schemaContext.get());
  81                     w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaForGetConfig, codecProvider);
  82                 }
  83             } else {
  84                 w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, codecProvider);
  85             }
  86         } catch (final UnsupportedDataTypeException e) {
  87             throw new IllegalArgumentException("Unable to create message", e);
  88         }
  89         w3cPayload.getDocumentElement().setAttribute("message-id", counter.getNewMessageId(MESSAGE_ID_PREFIX));
  90         return new NetconfMessage(w3cPayload);
  91     }
  92
  93     @Override
  94     public synchronized RpcResult<CompositeNode> toRpcResult(final NetconfMessage message, final QName rpc) {
  95         if(schemaContext.isPresent()) {
  96             return toRpcResult(message, rpc, schemaContext.get());
  97         } else {
  98             final CompositeNode node = (CompositeNode) XmlDocumentUtils.toDomNode(message.getDocument());
  99             return RpcResultBuilder.success( node ).build();
 100         }
 101     }
 102
 103     private static RpcResult<CompositeNode> toRpcResult(final NetconfMessage message, final QName rpc, final SchemaContext context) {
 104         final CompositeNode compositeNode;
 105         if (NetconfMessageTransformUtil.isDataRetrievalOperation(rpc)) {
 106             final Element xmlData = NetconfMessageTransformUtil.getDataSubtree(message.getDocument());
 107             final List<org.opendaylight.yangtools.yang.data.api.Node<?>> dataNodes = XmlDocumentUtils.toDomNodes(xmlData,
 108                     Optional.of(context.getDataDefinitions()), context);
 109
 110             final CompositeNodeBuilder<ImmutableCompositeNode> it = ImmutableCompositeNode.builder();
 111             it.setQName(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_QNAME);
 112             it.add(ImmutableCompositeNode.create(NetconfMessageTransformUtil.NETCONF_DATA_QNAME, dataNodes));
 113             compositeNode = it.toInstance();
 114         } else {
 115             final CompositeNode rpcReply = XmlDocumentUtils.rpcReplyToDomNodes(message.getDocument(), rpc, context);
 116             if (rpcReply != null) {
 117                 compositeNode = rpcReply;
 118             } else {
 119                 compositeNode = (CompositeNode) XmlDocumentUtils.toDomNode(message.getDocument());
 120             }
 121         }
 122         return RpcResultBuilder.success( compositeNode ).build();
 123     }
 124
 125     @Override
 126     public synchronized void onGlobalContextUpdated(final SchemaContext schemaContext) {
 127         this.schemaContext = Optional.of(schemaContext);
 128     }
 129 }