public class XmlFrameDecoder extends ByteToMessageDecoder
+-----+-----+-----------+ | <an | Xml | Element/> | +-----+-----+-----------+this decoder would output a single frame:
+-----------------+ | <anXmlElement/> | +-----------------+Given an input array of bytes split over 5 frames like this:
+-----+-----+-----------+-----+----------------------------------+ | <an | Xml | Element/> | <ro | ot><child>content</child></root> | +-----+-----+-----------+-----+----------------------------------+this decoder would output two frames:
+-----------------+-------------------------------------+ | <anXmlElement/> | <root><child>content</child></root> | +-----------------+-------------------------------------+Please note that this decoder is not suitable for xml streaming protocols such as XMPP, where an initial xml element opens the stream and only gets closed at the end of the session, although this class could probably allow for such type of message flow with minor modifications.
ByteToMessageDecoder.CumulatorChannelHandler.Sharable| Modifier and Type | Field and Description |
|---|---|
private int |
maxFrameLength |
COMPOSITE_CUMULATOR, MERGE_CUMULATOR| Constructor and Description |
|---|
XmlFrameDecoder(int maxFrameLength) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
decode(ChannelHandlerContext ctx,
ByteBuf in,
java.util.List<java.lang.Object> out)
Decode the from one
ByteBuf to an other. |
private static ByteBuf |
extractFrame(ByteBuf buffer,
int index,
int length) |
private static void |
fail(ChannelHandlerContext ctx) |
private void |
fail(long frameLength) |
private static boolean |
isCDATABlockStart(ByteBuf in,
int i) |
private static boolean |
isCommentBlockStart(ByteBuf in,
int i) |
private static boolean |
isValidStartCharForXmlElement(byte b)
Asks whether the given byte is a valid
start char for an xml element name.
|
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggeredchannelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaughtensureNotSharable, handlerAdded, isSharableclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waithandlerAddedprotected void decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out) throws java.lang.Exception
ByteToMessageDecoderByteBuf to an other. This method will be called till either the input
ByteBuf has nothing to read when return from this method or till nothing was read from the input
ByteBuf.decode in class ByteToMessageDecoderctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs toin - the ByteBuf from which to read dataout - the List to which decoded messages should be addedjava.lang.Exception - is thrown if an error occursprivate void fail(long frameLength)
private static void fail(ChannelHandlerContext ctx)
private static boolean isValidStartCharForXmlElement(byte b)
b - the input charprivate static boolean isCommentBlockStart(ByteBuf in, int i)
private static boolean isCDATABlockStart(ByteBuf in, int i)