org.springframework.http.codec.json

Class JsonObjectDecoder

java.lang.Object

org.springframework.core.codec.AbstractDecoder<DataBuffer>

org.springframework.http.codec.json.JsonObjectDecoder

All Implemented Interfaces:

Decoder<DataBuffer>

class JsonObjectDecoder
extends AbstractDecoder<DataBuffer>

Decode an arbitrary split byte stream representing JSON objects to a byte stream where each chunk is a well-formed JSON object.

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.

Based on Netty JsonObjectDecoder

Since:

5.0

Author:

Sebastien Deleuze

Field Summary

Fields

Modifier and Type	Field and Description
private int	maxObjectLength
private static int	ST_CORRUPTED
private static int	ST_DECODING_ARRAY_STREAM
private static int	ST_DECODING_NORMAL
private static int	ST_INIT
private boolean	streamArrayElements

Constructor Summary

Constructors

Constructor and Description
JsonObjectDecoder()
JsonObjectDecoder(boolean streamArrayElements)
JsonObjectDecoder(int maxObjectLength)
JsonObjectDecoder(int maxObjectLength, boolean streamArrayElements)

Method Summary

Modifier and Type	Method and Description
<any>	decode(<any> inputStream, ResolvableType elementType, MimeType mimeType, java.util.Map<java.lang.String,java.lang.Object> hints) Decode a DataBuffer input stream into a Flux of T.

Methods inherited from class org.springframework.core.codec.AbstractDecoder

canDecode, decodeToMono, getDecodableMimeTypes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ST_CORRUPTED

private static final int ST_CORRUPTED

See Also:

Constant Field Values

ST_INIT

private static final int ST_INIT

See Also:

Constant Field Values

ST_DECODING_NORMAL

private static final int ST_DECODING_NORMAL

See Also:

Constant Field Values

ST_DECODING_ARRAY_STREAM

private static final int ST_DECODING_ARRAY_STREAM

See Also:

Constant Field Values

maxObjectLength

private final int maxObjectLength

streamArrayElements

private final boolean streamArrayElements

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 an IllegalStateException 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

Method Detail

decode

public <any> decode(<any> inputStream,
                    ResolvableType elementType,
                    MimeType mimeType,
                    java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: Decoder

Decode a DataBuffer input stream into a Flux of T.

Parameters:

inputStream - the DataBuffer input stream to decode

elementType - the expected type of elements in the output stream; this type must have been previously passed to the Decoder.canDecode(org.springframework.core.ResolvableType, org.springframework.util.MimeType) method and it must have returned true.

mimeType - the MIME type associated with the input stream, optional

hints - additional information about how to do encode

Returns:

the output stream with decoded elements