opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/handler/NetconfEXIToMessageDecoder.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.netconf.util.handler;
   9
  10 import java.io.InputStream;
  11 import java.util.List;
  12
  13 import javax.xml.transform.TransformerFactory;
  14 import javax.xml.transform.dom.DOMResult;
  15 import javax.xml.transform.sax.SAXTransformerFactory;
  16 import javax.xml.transform.sax.TransformerHandler;
  17
  18 import org.opendaylight.controller.netconf.api.NetconfMessage;
  19 import org.openexi.sax.EXIReader;
  20 import org.slf4j.Logger;
  21 import org.slf4j.LoggerFactory;
  22 import org.w3c.dom.Document;
  23 import org.xml.sax.InputSource;
  24
  25 import com.google.common.base.Preconditions;
  26
  27 import io.netty.buffer.ByteBuf;
  28 import io.netty.buffer.ByteBufInputStream;
  29 import io.netty.buffer.ByteBufUtil;
  30 import io.netty.channel.ChannelHandlerContext;
  31 import io.netty.handler.codec.ByteToMessageDecoder;
  32
  33 public final class NetconfEXIToMessageDecoder extends ByteToMessageDecoder {
  34
  35     private static final Logger LOG = LoggerFactory.getLogger(NetconfEXIToMessageDecoder.class);
  36
  37     private final NetconfEXICodec codec;
  38
  39     public NetconfEXIToMessageDecoder(final NetconfEXICodec codec) {
  40         this.codec = Preconditions.checkNotNull(codec);
  41     }
  42
  43     @Override
  44     protected void decode(final ChannelHandlerContext ctx, final ByteBuf in, final List<Object> out) throws Exception {
  45         /*
  46          * Note that we could loop here and process all the messages, but we can't do that.
  47          * The reason is <stop-exi> operation, which has the contract of immediately stopping
  48          * the use of EXI, which means the next message needs to be decoded not by us, but rather
  49          * by the XML decoder.
  50          */
  51
  52         // If empty Byte buffer is passed to r.parse, EOFException is thrown
  53         if (in.isReadable() == false) {
  54             LOG.debug("No more content in incoming buffer.");
  55             return;
  56         }
  57
  58         LOG.trace("Received to decode: {}", ByteBufUtil.hexDump(in));
  59
  60         final EXIReader r = codec.getReader();
  61
  62         final SAXTransformerFactory transformerFactory
  63                 = (SAXTransformerFactory) TransformerFactory.newInstance();
  64         final TransformerHandler handler = transformerFactory.newTransformerHandler();
  65         r.setContentHandler(handler);
  66
  67         final DOMResult domResult = new DOMResult();
  68         handler.setResult(domResult);
  69
  70         try (final InputStream is = new ByteBufInputStream(in)) {
  71             r.parse(new InputSource(is));
  72         }
  73
  74         out.add(new NetconfMessage((Document) domResult.getNode()));
  75     }
  76 }