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.netconf.nettyutil.handler;
10 import com.google.common.annotations.VisibleForTesting;
11 import com.google.common.base.Optional;
12 import io.netty.buffer.ByteBuf;
13 import io.netty.buffer.ByteBufOutputStream;
14 import io.netty.channel.ChannelHandlerContext;
15 import io.netty.handler.codec.MessageToByteEncoder;
16 import java.io.BufferedWriter;
17 import java.io.IOException;
18 import java.io.OutputStream;
19 import java.io.OutputStreamWriter;
20 import javax.xml.transform.OutputKeys;
21 import javax.xml.transform.Transformer;
22 import javax.xml.transform.TransformerException;
23 import javax.xml.transform.TransformerFactory;
24 import javax.xml.transform.dom.DOMSource;
25 import javax.xml.transform.stream.StreamResult;
26 import org.opendaylight.controller.netconf.api.NetconfMessage;
27 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
28 import org.slf4j.Logger;
29 import org.slf4j.LoggerFactory;
30 import org.w3c.dom.Comment;
32 public class NetconfMessageToXMLEncoder extends MessageToByteEncoder<NetconfMessage> {
33 private static final Logger LOG = LoggerFactory.getLogger(NetconfMessageToXMLEncoder.class);
34 private static final TransformerFactory FACTORY = TransformerFactory.newInstance();
36 private final Optional<String> clientId;
38 public NetconfMessageToXMLEncoder() {
39 this(Optional.<String>absent());
42 public NetconfMessageToXMLEncoder(Optional<String> clientId) {
43 this.clientId = clientId;
48 public void encode(ChannelHandlerContext ctx, NetconfMessage msg, ByteBuf out) throws IOException, TransformerException {
49 LOG.trace("Sent to encode : {}", XmlUtil.toString(msg.getDocument()));
51 if (clientId.isPresent()) {
52 Comment comment = msg.getDocument().createComment("clientId:" + clientId.get());
53 msg.getDocument().appendChild(comment);
56 try (OutputStream os = new ByteBufOutputStream(out)) {
57 Transformer transformer = FACTORY.newTransformer();
58 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
59 transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
61 // Wrap OutputStreamWriter with BufferedWriter as suggested in javadoc for OutputStreamWriter
62 StreamResult result = new StreamResult(new BufferedWriter(new OutputStreamWriter(os)));
63 DOMSource source = new DOMSource(msg.getDocument());
64 transformer.transform(source, result);