2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.sal.connect.netconf.schema.mapping;
10 import com.google.common.base.Optional;
11 import java.util.List;
13 import javax.activation.UnsupportedDataTypeException;
14 import org.opendaylight.controller.netconf.api.NetconfMessage;
15 import org.opendaylight.controller.sal.connect.api.MessageTransformer;
16 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
17 import org.opendaylight.controller.sal.connect.util.MessageCounter;
18 import org.opendaylight.yangtools.yang.common.QName;
19 import org.opendaylight.yangtools.yang.common.RpcResult;
20 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
21 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
22 import org.opendaylight.yangtools.yang.data.impl.CompositeNodeTOImpl;
23 import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode;
24 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlCodecProvider;
25 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
26 import org.opendaylight.yangtools.yang.data.impl.util.CompositeNodeBuilder;
27 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
28 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
29 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
30 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
31 import org.w3c.dom.Document;
32 import org.w3c.dom.Element;
34 public class NetconfMessageTransformer implements MessageTransformer<NetconfMessage> {
36 public static final String MESSAGE_ID_PREFIX = "m";
38 private Optional<SchemaContext> schemaContext = Optional.absent();
39 private final MessageCounter counter;
41 public NetconfMessageTransformer() {
42 this.counter = new MessageCounter();
46 public synchronized CompositeNode toNotification(final NetconfMessage message) {
47 if(schemaContext.isPresent()) {
48 return toNotification(message, schemaContext.get());
50 return XmlDocumentUtils.notificationToDomNodes(message.getDocument(), Optional.<Set<NotificationDefinition>>absent());
54 private static CompositeNode toNotification(final NetconfMessage message, final SchemaContext ctx) {
55 final Set<NotificationDefinition> notifications = ctx.getNotifications();
56 final Document document = message.getDocument();
57 return XmlDocumentUtils.notificationToDomNodes(document, Optional.fromNullable(notifications), ctx);
61 public NetconfMessage toRpcRequest(final QName rpc, final CompositeNode node) {
62 final CompositeNodeTOImpl rpcPayload = NetconfMessageTransformUtil.wrap(
63 NetconfMessageTransformUtil.NETCONF_RPC_QNAME, NetconfMessageTransformUtil.flattenInput(node));
64 final Document w3cPayload;
66 final XmlCodecProvider codecProvider = XmlDocumentUtils.defaultValueCodecProvider();
67 if(schemaContext.isPresent()) {
68 if (NetconfMessageTransformUtil.isDataEditOperation(rpc)) {
69 final DataNodeContainer schemaForEdit = NetconfMessageTransformUtil.createSchemaForEdit(schemaContext.get());
70 w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaContext.get(), schemaForEdit, codecProvider);
71 } else if (NetconfMessageTransformUtil.isGetOperation(rpc)) {
72 final DataNodeContainer schemaForGet = NetconfMessageTransformUtil.createSchemaForGet(schemaContext.get());
73 w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaContext.get(), schemaForGet, codecProvider);
74 } else if (NetconfMessageTransformUtil.isGetConfigOperation(rpc)) {
75 final DataNodeContainer schemaForGetConfig = NetconfMessageTransformUtil.createSchemaForGetConfig(schemaContext.get());
76 w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaContext.get(), schemaForGetConfig, codecProvider);
78 final Optional<RpcDefinition> schemaForRpc = NetconfMessageTransformUtil.findSchemaForRpc(rpc, schemaContext.get());
79 if(schemaForRpc.isPresent()) {
80 final DataNodeContainer schemaForGetConfig = NetconfMessageTransformUtil.createSchemaForRpc(schemaForRpc.get());
81 w3cPayload = XmlDocumentUtils.toDocument(rpcPayload, schemaContext.get(), schemaForGetConfig, codecProvider);
83 w3cPayload = toRpcRequestWithoutSchema(rpcPayload, codecProvider);
87 w3cPayload = toRpcRequestWithoutSchema(rpcPayload, codecProvider);
89 } catch (final UnsupportedDataTypeException e) {
90 throw new IllegalArgumentException("Unable to create message", e);
92 w3cPayload.getDocumentElement().setAttribute("message-id", counter.getNewMessageId(MESSAGE_ID_PREFIX));
93 return new NetconfMessage(w3cPayload);
96 private Document toRpcRequestWithoutSchema(final CompositeNodeTOImpl rpcPayload, final XmlCodecProvider codecProvider) {
97 return XmlDocumentUtils.toDocument(rpcPayload, codecProvider);
101 public synchronized RpcResult<CompositeNode> toRpcResult(final NetconfMessage message, final QName rpc) {
102 if(schemaContext.isPresent()) {
103 return toRpcResult(message, rpc, schemaContext.get());
105 final CompositeNode node = (CompositeNode) XmlDocumentUtils.toDomNode(message.getDocument());
106 return RpcResultBuilder.success(node).build();
110 private static RpcResult<CompositeNode> toRpcResult(final NetconfMessage message, final QName rpc, final SchemaContext context) {
111 final CompositeNode compositeNode;
112 if (NetconfMessageTransformUtil.isDataRetrievalOperation(rpc)) {
113 final Element xmlData = NetconfMessageTransformUtil.getDataSubtree(message.getDocument());
114 final List<org.opendaylight.yangtools.yang.data.api.Node<?>> dataNodes = XmlDocumentUtils.toDomNodes(xmlData,
115 Optional.of(context.getDataDefinitions()), context);
117 final CompositeNodeBuilder<ImmutableCompositeNode> it = ImmutableCompositeNode.builder();
118 it.setQName(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_QNAME);
119 it.add(ImmutableCompositeNode.create(NetconfMessageTransformUtil.NETCONF_DATA_QNAME, dataNodes));
120 compositeNode = it.toInstance();
122 final CompositeNode rpcReply = XmlDocumentUtils.rpcReplyToDomNodes(message.getDocument(), rpc, context);
123 if (rpcReply != null) {
124 compositeNode = rpcReply;
126 compositeNode = (CompositeNode) XmlDocumentUtils.toDomNode(message.getDocument());
129 return RpcResultBuilder.success( compositeNode ).build();
133 public synchronized void onGlobalContextUpdated(final SchemaContext schemaContext) {
134 this.schemaContext = Optional.fromNullable(schemaContext);