Package io.micronaut.json.body

Class JsonMessageHandler<T>

java.lang.Object

io.micronaut.json.body.JsonMessageHandler<T>

Type Parameters:

T - The type to read/write

All Implemented Interfaces:

MessageBodyHandler<T>, MessageBodyReader<T>, MessageBodyWriter<T>, ResponseBodyWriter<T>, CustomizableJsonHandler

@Order(-10)
@Singleton
@ProducesJson
@ConsumesJson
public final class JsonMessageHandler<T>
extends Object
implements MessageBodyHandler<T>, CustomizableJsonHandler, ResponseBodyWriter<T>

Body handler for JSON.

Since:

4.0.0

Author:

Jonas Konrad

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	JsonMessageHandler.ConsumesJson	A Consumes with JSON supported types.
static @interface	JsonMessageHandler.ProducesJson	A Produces with JSON supported types.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ORDER	The JSON handler should be preferred if for any type.

Constructor Summary

Constructors

Constructor	Description
JsonMessageHandler(JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
JsonMessageHandler<T>	createSpecific(@NonNull Argument<T> type)	Prepare a MessageBodyWriter that will write the given type.
CustomizableJsonHandler	customize(JsonFeatures jsonFeatures)
@NonNull JsonMapper	getJsonMapper()	Get the json mapper used by this handler.
boolean	isReadable(@NonNull Argument<T> type, MediaType mediaType)	Is the type readable.
boolean	isWriteable(@NonNull Argument<T> type, MediaType mediaType)	Is the type writeable.
T	read(@NonNull Argument<T> type, MediaType mediaType, @NonNull Headers httpHeaders, @NonNull ByteBuffer<?> byteBuffer)	Reads an object from the given byte buffer.
T	read(@NonNull Argument<T> type, MediaType mediaType, @NonNull Headers httpHeaders, @NonNull InputStream inputStream)	Reads an object from the given byte buffer.
@NonNull CloseableByteBody	writePiece(@NonNull ByteBodyFactory bodyFactory, @NonNull HttpRequest<?> request, @NonNull HttpResponse<?> response, @NonNull Argument<T> type, @NonNull MediaType mediaType, T object)	Write a piece of a larger response, e.g.
void	writeTo(Argument<T> type, @NonNull MediaType mediaType, T object, MutableHeaders outgoingHeaders, @NonNull OutputStream outputStream)	Writes an object to the given output stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.body.MessageBodyWriter

isBlocking, writeTo

Methods inherited from interface io.micronaut.http.body.ResponseBodyWriter

write

Field Details

ORDER

public static final int ORDER

The JSON handler should be preferred if for any type.

See Also:

• Constant Field Values

Constructor Details

JsonMessageHandler

public JsonMessageHandler(JsonMapper jsonMapper)

Method Details

getJsonMapper

@NonNull
public @NonNull JsonMapper getJsonMapper()

Get the json mapper used by this handler.

Returns:

The mapper

isReadable

public boolean isReadable(@NonNull
 @NonNull Argument<T> type,
 MediaType mediaType)

Description copied from interface: MessageBodyReader

Is the type readable.

Specified by:

isReadable in interface MessageBodyReader<T>

Parameters:

type - The type

mediaType - The media type, can be null

Returns:

True if is readable

createSpecific

public JsonMessageHandler<T> createSpecific(@NonNull
 @NonNull Argument<T> type)

Description copied from interface: MessageBodyWriter

Prepare a MessageBodyWriter that will write the given type. This can be used for precomputing some route data.

Specified by:

createSpecific in interface MessageBodyWriter<T>

Parameters:

type - The type

Returns:

The closure

read

public T read(@NonNull
 @NonNull Argument<T> type,
 MediaType mediaType,
 @NonNull
 @NonNull Headers httpHeaders,
 @NonNull
 @NonNull ByteBuffer<?> byteBuffer)
       throws CodecException

Description copied from interface: MessageBodyReader

Reads an object from the given byte buffer.

Specified by:

read in interface MessageBodyReader<T>

Parameters:

type - The type being decoded.

mediaType - The media type, can be null

httpHeaders - The HTTP headers

byteBuffer - The byte buffer

Returns:

The read object or null

Throws:

CodecException - If an error occurs decoding

read

public T read(@NonNull
 @NonNull Argument<T> type,
 MediaType mediaType,
 @NonNull
 @NonNull Headers httpHeaders,
 @NonNull
 @NonNull InputStream inputStream)
       throws CodecException

Description copied from interface: MessageBodyReader

Reads an object from the given byte buffer.

Specified by:

read in interface MessageBodyReader<T>

Parameters:

type - The type being decoded.

mediaType - The media type, can be null

httpHeaders - The HTTP headers

inputStream - The input stream

Returns:

The read object or null

Throws:

CodecException - If an error occurs decoding

isWriteable

public boolean isWriteable(@NonNull
 @NonNull Argument<T> type,
 MediaType mediaType)

Description copied from interface: MessageBodyWriter

Is the type writeable.

Specified by:

isWriteable in interface MessageBodyWriter<T>

Parameters:

type - The type

mediaType - The media type, can be null

Returns:

True if is writable

writeTo

public void writeTo(Argument<T> type,
 @NonNull
 @NonNull MediaType mediaType,
 T object,
 MutableHeaders outgoingHeaders,
 @NonNull
 @NonNull OutputStream outputStream)
             throws CodecException

Description copied from interface: MessageBodyWriter

Writes an object to the given output stream.

Specified by:

writeTo in interface MessageBodyWriter<T>

Parameters:

type - The type

mediaType - The media type

object - The object to write

outgoingHeaders - The HTTP headers

outputStream - The output stream

Throws:

CodecException - If an error occurs decoding

writePiece

@NonNull
public @NonNull CloseableByteBody writePiece(@NonNull
 @NonNull ByteBodyFactory bodyFactory,
 @NonNull
 @NonNull HttpRequest<?> request,
 @NonNull
 @NonNull HttpResponse<?> response,
 @NonNull
 @NonNull Argument<T> type,
 @NonNull
 @NonNull MediaType mediaType,
 T object)
                                      throws CodecException

Description copied from interface: ResponseBodyWriter

Write a piece of a larger response, e.g. when writing a Publisher or a part of a multipart response. In this case, response headers cannot be modified.

Specified by:

writePiece in interface ResponseBodyWriter<T>

Parameters:

bodyFactory - The buffer factory

request - The request

response - The response this piece is part of

type - The type of this piece

mediaType - The media type of this piece

object - The piece to write

Returns:

The response bytes

Throws:

CodecException - If an error occurs encoding

customize

public CustomizableJsonHandler customize(JsonFeatures jsonFeatures)

Specified by:

customize in interface CustomizableJsonHandler