Merge "Untangle the XML/Hello message decoders"
authorTony Tkacik <ttkacik@cisco.com>
Tue, 18 Feb 2014 11:05:27 +0000 (11:05 +0000)
committerGerrit Code Review <gerrit@opendaylight.org>
Tue, 18 Feb 2014 11:05:28 +0000 (11:05 +0000)
opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/handler/NetconfChunkAggregator.java
opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/handler/NetconfXMLToHelloMessageDecoder.java
opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/handler/NetconfXMLToMessageDecoder.java
opendaylight/netconf/netconf-util/src/test/java/org/opendaylight/controller/netconf/util/messages/NetconfMessageFactoryTest.java

index cee8e71..f7045c3 100644 (file)
@@ -46,6 +46,7 @@ public class NetconfChunkAggregator extends ByteToMessageDecoder {
             {
                 final byte b = in.readByte();
                 if (b != '\n') {
+                    logger.debug("Got byte {} while waiting for {}", b, (byte)'\n');
                     throw new IllegalStateException("Malformed chunk header encountered (byte 0)");
                 }
 
@@ -56,6 +57,7 @@ public class NetconfChunkAggregator extends ByteToMessageDecoder {
             {
                 final byte b = in.readByte();
                 if (b != '#') {
+                    logger.debug("Got byte {} while waiting for {}", b, (byte)'#');
                     throw new IllegalStateException("Malformed chunk header encountered (byte 1)");
                 }
 
@@ -66,6 +68,7 @@ public class NetconfChunkAggregator extends ByteToMessageDecoder {
             {
                 final byte b = in.readByte();
                 if (b < '1' || b > '9') {
+                    logger.debug("Got byte {} while waiting for {}-{}", b, (byte)'1', (byte)'9');
                     throw new IllegalStateException("Invalid chunk size encountered (byte 0)");
                 }
 
@@ -82,6 +85,7 @@ public class NetconfChunkAggregator extends ByteToMessageDecoder {
                 }
 
                 if (b < '0' || b > '9') {
+                    logger.debug("Got byte {} while waiting for {}-{}", b, (byte)'0', (byte)'9');
                     throw new IllegalStateException("Invalid chunk size encountered");
                 }
 
@@ -89,6 +93,7 @@ public class NetconfChunkAggregator extends ByteToMessageDecoder {
                 chunkSize += b - '0';
 
                 if (chunkSize > maxChunkSize) {
+                    logger.debug("Parsed chunk size {}, maximum allowed is {}", chunkSize, maxChunkSize);
                     throw new IllegalStateException("Maximum chunk size exceeded");
                 }
                 break;
index 42586a5..248871a 100644 (file)
@@ -7,6 +7,12 @@
  */
 package org.opendaylight.controller.netconf.util.handler;
 
+import io.netty.buffer.ByteBuf;
+import io.netty.buffer.ByteBufUtil;
+import io.netty.channel.ChannelHandlerContext;
+import io.netty.handler.codec.ByteToMessageDecoder;
+
+import java.io.ByteArrayInputStream;
 import java.nio.ByteBuffer;
 import java.util.Arrays;
 import java.util.List;
@@ -14,8 +20,12 @@ import java.util.List;
 import org.opendaylight.controller.netconf.api.NetconfMessage;
 import org.opendaylight.controller.netconf.util.messages.NetconfHelloMessage;
 import org.opendaylight.controller.netconf.util.messages.NetconfHelloMessageAdditionalHeader;
+import org.opendaylight.controller.netconf.util.xml.XmlUtil;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.w3c.dom.Document;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Charsets;
 import com.google.common.collect.ImmutableList;
 
@@ -25,7 +35,8 @@ import com.google.common.collect.ImmutableList;
  * {@link org.opendaylight.controller.netconf.util.messages.NetconfHelloMessage}
  * . Used by netconf server to retrieve information about session metadata.
  */
-public class NetconfXMLToHelloMessageDecoder extends NetconfXMLToMessageDecoder {
+public final class NetconfXMLToHelloMessageDecoder extends ByteToMessageDecoder {
+    private static final Logger LOG = LoggerFactory.getLogger(NetconfXMLToHelloMessageDecoder.class);
 
     private static final List<byte[]> POSSIBLE_ENDS = ImmutableList.of(
             new byte[] { ']', '\n' },
@@ -35,34 +46,46 @@ public class NetconfXMLToHelloMessageDecoder extends NetconfXMLToMessageDecoder
             new byte[] { '\r', '\n', '[' },
             new byte[] { '\n', '[' });
 
-    private String additionalHeaderCache;
-
     @Override
-    protected byte[] preprocessMessageBytes(byte[] bytes) {
-        // Extract bytes containing header with additional metadata
-
-        if (startsWithAdditionalHeader(bytes)) {
-            // Auth information containing username, ip address... extracted for monitoring
-            int endOfAuthHeader = getAdditionalHeaderEndIndex(bytes);
-            if (endOfAuthHeader > -1) {
-                byte[] additionalHeaderBytes = Arrays.copyOfRange(bytes, 0, endOfAuthHeader + 2);
-                additionalHeaderCache = additionalHeaderToString(additionalHeaderBytes);
-                bytes = Arrays.copyOfRange(bytes, endOfAuthHeader + 2, bytes.length);
-            }
+    @VisibleForTesting
+    public void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
+        if (in.readableBytes() == 0) {
+            LOG.debug("No more content in incoming buffer.");
+            return;
         }
 
-        return bytes;
-    }
+        in.markReaderIndex();
+        try {
+            LOG.trace("Received to decode: {}", ByteBufUtil.hexDump(in));
+            byte[] bytes = new byte[in.readableBytes()];
+            in.readBytes(bytes);
+
+            logMessage(bytes);
+
+            // Extract bytes containing header with additional metadata
+            String additionalHeader = null;
+            if (startsWithAdditionalHeader(bytes)) {
+                // Auth information containing username, ip address... extracted for monitoring
+                int endOfAuthHeader = getAdditionalHeaderEndIndex(bytes);
+                if (endOfAuthHeader > -1) {
+                    byte[] additionalHeaderBytes = Arrays.copyOfRange(bytes, 0, endOfAuthHeader + 2);
+                    additionalHeader = additionalHeaderToString(additionalHeaderBytes);
+                    bytes = Arrays.copyOfRange(bytes, endOfAuthHeader + 2, bytes.length);
+                }
+            }
 
-    @Override
-    protected void cleanUpAfterDecode() {
-        additionalHeaderCache = null;
-    }
+            Document doc = XmlUtil.readXmlToDocument(new ByteArrayInputStream(bytes));
 
-    @Override
-    protected NetconfMessage buildNetconfMessage(Document doc) {
-        return new NetconfHelloMessage(doc, additionalHeaderCache == null ? null
-                : NetconfHelloMessageAdditionalHeader.fromString(additionalHeaderCache));
+            final NetconfMessage message;
+            if (additionalHeader != null) {
+                message = new NetconfHelloMessage(doc, NetconfHelloMessageAdditionalHeader.fromString(additionalHeader));
+            } else {
+                message = new NetconfHelloMessage(doc);
+            }
+            out.add(message);
+        } finally {
+            in.discardReadBytes();
+        }
     }
 
     private int getAdditionalHeaderEndIndex(byte[] bytes) {
@@ -102,6 +125,12 @@ public class NetconfXMLToHelloMessageDecoder extends NetconfXMLToMessageDecoder
         return -1;
     }
 
+
+    private void logMessage(byte[] bytes) {
+        String s = Charsets.UTF_8.decode(ByteBuffer.wrap(bytes)).toString();
+        LOG.debug("Parsing message \n{}", s);
+    }
+
     private boolean startsWithAdditionalHeader(byte[] bytes) {
         for (byte[] possibleStart : POSSIBLE_STARTS) {
             int i = 0;
index b697edf..06a4dc7 100644 (file)
@@ -7,73 +7,32 @@
  */
 package org.opendaylight.controller.netconf.util.handler;
 
-import java.io.ByteArrayInputStream;
-import java.nio.ByteBuffer;
+import io.netty.buffer.ByteBuf;
+import io.netty.buffer.ByteBufInputStream;
+import io.netty.buffer.ByteBufUtil;
+import io.netty.channel.ChannelHandlerContext;
+import io.netty.handler.codec.ByteToMessageDecoder;
+
 import java.util.List;
 
-import org.opendaylight.controller.netconf.api.NetconfDeserializerException;
 import org.opendaylight.controller.netconf.api.NetconfMessage;
 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.w3c.dom.Document;
 
 import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Charsets;
 
-import io.netty.buffer.ByteBuf;
-import io.netty.buffer.ByteBufUtil;
-import io.netty.channel.ChannelHandlerContext;
-import io.netty.handler.codec.ByteToMessageDecoder;
-
-public class NetconfXMLToMessageDecoder extends ByteToMessageDecoder {
+public final class NetconfXMLToMessageDecoder extends ByteToMessageDecoder {
     private static final Logger LOG = LoggerFactory.getLogger(NetconfXMLToMessageDecoder.class);
 
     @Override
     @VisibleForTesting
     public void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
-        if (in.readableBytes() == 0) {
-            LOG.debug("No more content in incoming buffer.");
-            return;
-        }
-
-        in.markReaderIndex();
-        try {
+        if (in.readableBytes() != 0) {
             LOG.trace("Received to decode: {}", ByteBufUtil.hexDump(in));
-            byte[] bytes = new byte[in.readableBytes()];
-            in.readBytes(bytes);
-
-            logMessage(bytes);
-
-            bytes = preprocessMessageBytes(bytes);
-            NetconfMessage message;
-            try {
-                Document doc = XmlUtil.readXmlToDocument(new ByteArrayInputStream(bytes));
-                message = buildNetconfMessage(doc);
-            } catch (Exception e) {
-                throw new NetconfDeserializerException("Could not parse message from " + new String(bytes), e);
-            }
-
-            out.add(message);
-        } finally {
-            in.discardReadBytes();
-            cleanUpAfterDecode();
+            out.add(new NetconfMessage(XmlUtil.readXmlToDocument(new ByteBufInputStream(in))));
+        } else {
+            LOG.debug("No more content in incoming buffer.");
         }
     }
-
-    protected void cleanUpAfterDecode() {}
-
-    protected NetconfMessage buildNetconfMessage(Document doc) {
-        return new NetconfMessage(doc);
-    }
-
-    protected byte[] preprocessMessageBytes(byte[] bytes) {
-        return bytes;
-    }
-
-    private void logMessage(byte[] bytes) {
-        String s = Charsets.UTF_8.decode(ByteBuffer.wrap(bytes)).toString();
-        LOG.debug("Parsing message \n{}", s);
-    }
-
 }
index 6b7bffc..18830f8 100644 (file)
@@ -16,14 +16,13 @@ import java.util.List;
 
 import org.junit.Test;
 import org.opendaylight.controller.netconf.util.handler.NetconfXMLToHelloMessageDecoder;
-import org.opendaylight.controller.netconf.util.handler.NetconfXMLToMessageDecoder;
 
 import com.google.common.io.Files;
 
 public class NetconfMessageFactoryTest {
     @Test
     public void testAuth() throws Exception {
-        NetconfXMLToMessageDecoder parser = new NetconfXMLToHelloMessageDecoder();
+        NetconfXMLToHelloMessageDecoder parser = new NetconfXMLToHelloMessageDecoder();
         File authHelloFile = new File(getClass().getResource("/netconfMessages/client_hello_with_auth.xml").getFile());
 
         final List<Object> out = new ArrayList<>();

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.