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.RpcDefinition;
  33 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  34 import org.w3c.dom.Document;
  35 import org.w3c.dom.Element;
  36
  37 public class NetconfMessageTransformer implements MessageTransformer<NetconfMessage> {
  38
  39     public static final String MESSAGE_ID_PREFIX = "m";
  40
  41     private Optional<SchemaContext> schemaContext = Optional.absent();
  42     private final MessageCounter counter;
  43
  44     public NetconfMessageTransformer() {
  45         this.counter = new MessageCounter();
  46     }
  47
  48     @Override
  49     public synchronized CompositeNode toNotification(final NetconfMessage message) {
  50         if(schemaContext.isPresent()) {
  51             return toNotification(message, schemaContext.get());
  52         } else {
  53             return XmlDocumentUtils.notificationToDomNodes(message.getDocument(), Optional.<Set<NotificationDefinition>>absent());
  54         }
  55     }
  56
  57     private static CompositeNode toNotification(final NetconfMessage message, final SchemaContext ctx) {
  58         final Set<NotificationDefinition> notifications = ctx.getNotifications();
  59         final Document document = message.getDocument();
  60         return XmlDocumentUtils.notificationToDomNodes(document, Optional.fromNullable(notifications), ctx);
  61     }
  62
  63     @Override
  64     public NetconfMessage toRpcRequest(final QName rpc, final CompositeNode node) {
  65         final CompositeNodeTOImpl rpcPayload = NetconfMessageTransformUtil.wrap(
  66                 NetconfMessageTransformUtil.NETCONF_RPC_QNAME, NetconfMessageTransformUtil.flattenInput(node));
  67         final Document w3cPayload;
  68         try {
  69             final XmlCodecProvider codecProvider = XmlDocumentUtils.defaultValueCodecProvider();
  70             if(schemaContext.isPresent()) {
  71                 if (NetconfMessageTransformUtil.isDataEditOperation(rpc)) {
  72                     final DataNodeContainer schemaForEdit = NetconfMessageTransformUtil.createSchemaForEdit(schemaContext.get());
  73                     w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaForEdit, codecProvider);
  74                 } else if (NetconfMessageTransformUtil.isGetOperation(rpc)) {
  75                     final DataNodeContainer schemaForGet = NetconfMessageTransformUtil.createSchemaForGet(schemaContext.get());
  76                     w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaForGet, codecProvider);
  77                 } else if (NetconfMessageTransformUtil.isGetConfigOperation(rpc)) {
  78                     final DataNodeContainer schemaForGetConfig = NetconfMessageTransformUtil.createSchemaForGetConfig(schemaContext.get());
  79                     w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaForGetConfig, codecProvider);
  80                 } else {
  81                     final Optional<RpcDefinition> schemaForRpc = NetconfMessageTransformUtil.findSchemaForRpc(rpc, schemaContext.get());
  82                     if(schemaForRpc.isPresent()) {
  83                         final DataNodeContainer schemaForGetConfig = NetconfMessageTransformUtil.createSchemaForRpc(schemaForRpc.get());
  84                         w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaForGetConfig, codecProvider);
  85                     } else {
  86                         w3cPayload = toRpcRequestWithoutSchema(rpcPayload, codecProvider);
  87                     }
  88                 }
  89             } else {
  90                 w3cPayload = toRpcRequestWithoutSchema(rpcPayload, codecProvider);
  91             }
  92         } catch (final UnsupportedDataTypeException e) {
  93             throw new IllegalArgumentException("Unable to create message", e);
  94         }
  95         w3cPayload.getDocumentElement().setAttribute("message-id", counter.getNewMessageId(MESSAGE_ID_PREFIX));
  96         return new NetconfMessage(w3cPayload);
  97     }
  98
  99     private Document toRpcRequestWithoutSchema(final CompositeNodeTOImpl rpcPayload, final XmlCodecProvider codecProvider) {
 100         return XmlDocumentUtils.toDocument(rpcPayload, codecProvider);
 101     }
 102
 103     @Override
 104     public synchronized RpcResult<CompositeNode> toRpcResult(final NetconfMessage message, final QName rpc) {
 105         if(schemaContext.isPresent()) {
 106             return toRpcResult(message, rpc, schemaContext.get());
 107         } else {
 108             final CompositeNode node = (CompositeNode) XmlDocumentUtils.toDomNode(message.getDocument());
 109             return RpcResultBuilder.success(node).build();
 110         }
 111     }
 112
 113     private static RpcResult<CompositeNode> toRpcResult(final NetconfMessage message, final QName rpc, final SchemaContext context) {
 114         final CompositeNode compositeNode;
 115         if (NetconfMessageTransformUtil.isDataRetrievalOperation(rpc)) {
 116             final Element xmlData = NetconfMessageTransformUtil.getDataSubtree(message.getDocument());
 117             final List<org.opendaylight.yangtools.yang.data.api.Node<?>> dataNodes = XmlDocumentUtils.toDomNodes(xmlData,
 118                     Optional.of(context.getDataDefinitions()), context);
 119
 120             final CompositeNodeBuilder<ImmutableCompositeNode> it = ImmutableCompositeNode.builder();
 121             it.setQName(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_QNAME);
 122             it.add(ImmutableCompositeNode.create(NetconfMessageTransformUtil.NETCONF_DATA_QNAME, dataNodes));
 123             compositeNode = it.toInstance();
 124         } else {
 125             final CompositeNode rpcReply = XmlDocumentUtils.rpcReplyToDomNodes(message.getDocument(), rpc, context);
 126             if (rpcReply != null) {
 127                 compositeNode = rpcReply;
 128             } else {
 129                 compositeNode = (CompositeNode) XmlDocumentUtils.toDomNode(message.getDocument());
 130             }
 131         }
 132         return RpcResultBuilder.success( compositeNode ).build();
 133     }
 134
 135     @Override
 136     public synchronized void onGlobalContextUpdated(final SchemaContext schemaContext) {
 137         this.schemaContext = Optional.of(schemaContext);
 138     }
 139 }