Class 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 the ChannelPipeline.

The byte stream is expected to be in UTF-8 character encoding or ASCII. The current implementation uses direct byte to char cast and then compares that char to a few low range ASCII characters like invalid input: '{@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. <p> 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.'

  • Field Details

    • ST_CORRUPTED

      private static final int ST_CORRUPTED
      See Also:
    • ST_INIT

      private static final int ST_INIT
      See Also:
    • ST_DECODING_NORMAL

      private static final int ST_DECODING_NORMAL
      See Also:
    • ST_DECODING_ARRAY_STREAM

      private static final int ST_DECODING_ARRAY_STREAM
      See Also:
    • openBraces

      private int openBraces
    • idx

      private int idx
    • lastReaderIndex

      private int lastReaderIndex
    • state

      private int state
    • insideString

      private boolean insideString
    • maxObjectLength

      private final int maxObjectLength
    • streamArrayElements

      private final boolean streamArrayElements
  • Constructor Details

    • 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 an TooLongFrameException 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 Details