Package io.netty.handler.codec.json
Class JsonObjectDecoder
- java.lang.Object
-
- io.netty.channel.ChannelHandlerAdapter
-
- io.netty.channel.ChannelInboundHandlerAdapter
-
- io.netty.handler.codec.ByteToMessageDecoder
-
- io.netty.handler.codec.json.JsonObjectDecoder
-
- All Implemented Interfaces:
ChannelHandler
,ChannelInboundHandler
public class JsonObjectDecoder extends ByteToMessageDecoder
Splits a byte stream of JSON objects and arrays into individual objects/arrays and passes them up theChannelPipeline
.The byte stream is expected to be in UTF-8 character encoding or ASCII. The current implementation uses direct
byte
tochar
cast and then compares thatchar
to a few low range ASCII characters like {@code '{'}, {@code '['} or {@code '"'}. UTF-8 is not using low range [0..0x7F] byte values for multibyte codepoint representations therefore fully supported by this implementation.This class does not do any real parsing or validation. A sequence of bytes is considered a JSON object/array if it contains a matching number of opening and closing braces/brackets. It's up to a subsequent {@link ChannelHandler} to parse the JSON text into a more usable form i.e. a POJO.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder
ByteToMessageDecoder.Cumulator
-
Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
ChannelHandler.Sharable
-
-
Field Summary
-
Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
-
-
Constructor Summary
Constructors Constructor Description JsonObjectDecoder()
JsonObjectDecoder(boolean streamArrayElements)
JsonObjectDecoder(int maxObjectLength)
JsonObjectDecoder(int maxObjectLength, boolean streamArrayElements)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)
Decode the from oneByteBuf
to an other.protected ByteBuf
extractObject(ChannelHandlerContext ctx, ByteBuf buffer, int index, int length)
Override this method if you want to filter the json objects/arrays that get passed through the pipeline.-
Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered
-
Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught
-
Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerAdded, isSharable
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.netty.channel.ChannelHandler
handlerAdded
-
-
-
-
Constructor Detail
-
JsonObjectDecoder
public JsonObjectDecoder()
-
JsonObjectDecoder
public JsonObjectDecoder(int maxObjectLength)
-
JsonObjectDecoder
public JsonObjectDecoder(boolean streamArrayElements)
-
JsonObjectDecoder
public JsonObjectDecoder(int maxObjectLength, boolean streamArrayElements)
- Parameters:
maxObjectLength
- maximum number of bytes a JSON object/array may use (including braces and all). Objects exceeding this length are dropped and anTooLongFrameException
is thrown.streamArrayElements
- if set to true and the "top level" JSON object is an array, each of its entries is passed through the pipeline individually and immediately after it was fully received, allowing for arrays with "infinitely" many elements.
-
-
Method Detail
-
decode
protected void decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out) throws java.lang.Exception
Description copied from class:ByteToMessageDecoder
Decode the from oneByteBuf
to an other. This method will be called till either the inputByteBuf
has nothing to read when return from this method or till nothing was read from the inputByteBuf
.- Specified by:
decode
in classByteToMessageDecoder
- Parameters:
ctx
- theChannelHandlerContext
which thisByteToMessageDecoder
belongs toin
- theByteBuf
from which to read dataout
- theList
to which decoded messages should be added- Throws:
java.lang.Exception
- is thrown if an error occurs
-
extractObject
protected ByteBuf extractObject(ChannelHandlerContext ctx, ByteBuf buffer, int index, int length)
Override this method if you want to filter the json objects/arrays that get passed through the pipeline.
-
-