Package io.micronaut.http.netty.body

Class NettyJsonHandler<T>

java.lang.Object

io.micronaut.http.netty.body.NettyJsonHandler<T>

Type Parameters:

T - The type

All Implemented Interfaces:

ChunkedMessageBodyReader<T>, MessageBodyHandler<T>, MessageBodyReader<T>, MessageBodyWriter<T>, CustomizableNettyJsonHandler, NettyBodyWriter<T>

@Singleton
@Internal
@Replaces(JsonMessageHandler.class)
@Produces({"application/json","text/json","application/hal+json","application/vnd.github+json","application/feed+json","application/json-patch+json","application/merge-patch+json","application/problem+json"})
@Consumes({"application/json","text/json","application/hal+json","application/vnd.github+json","application/feed+json","application/json-patch+json","application/merge-patch+json","application/problem+json"})
@Requires(beans=JsonMapper.class)
public final class NettyJsonHandler<T>
extends Object
implements MessageBodyHandler<T>, ChunkedMessageBodyReader<T>, CustomizableNettyJsonHandler, NettyBodyWriter<T>

Replacement for JsonMessageHandler with ChunkedMessageBodyReader support.

Constructor Summary

Constructors

Constructor	Description
NettyJsonHandler(JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
MessageBodyWriter<T>	createSpecific(Argument<T> type)	Prepare a MessageBodyWriter that will write the given type.
CustomizableNettyJsonHandler	customize(JsonFeatures jsonFeatures)
boolean	isBlocking()	true iff this closure can do a blocking read on the object it receives.
boolean	isReadable(Argument<T> type, MediaType mediaType)	Is the type readable.
boolean	isWriteable(Argument<T> type, MediaType mediaType)	Is the type writeable.
T	read(Argument<T> type, MediaType mediaType, Headers httpHeaders, ByteBuffer<?> byteBuffer)	Reads an object from the given byte buffer.
T	read(Argument<T> type, MediaType mediaType, Headers httpHeaders, InputStream inputStream)	Reads an object from the given byte buffer.
Publisher<T>	readChunked(Argument<T> type, MediaType mediaType, Headers httpHeaders, Publisher<ByteBuffer<?>> input)
void	writeTo(@NonNull HttpRequest<?> request, @NonNull MutableHttpResponse<T> outgoingResponse, @NonNull Argument<T> type, @NonNull MediaType mediaType, T object, @NonNull NettyWriteContext nettyContext)	Write an object to the given context.
ByteBuffer<?>	writeTo(Argument<T> type, MediaType mediaType, T object, MutableHeaders outgoingHeaders, ByteBufferFactory<?,?> bufferFactory)	Writes an object to the given stream.
void	writeTo(Argument<T> type, MediaType mediaType, T object, MutableHeaders outgoingHeaders, 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

Constructor Details

NettyJsonHandler

public NettyJsonHandler(JsonMapper jsonMapper)

Method Details

customize

public CustomizableNettyJsonHandler customize(JsonFeatures jsonFeatures)

Specified by:

customize in interface CustomizableNettyJsonHandler

readChunked

public Publisher<T> readChunked(Argument<T> type,
 MediaType mediaType,
 Headers httpHeaders,
 Publisher<ByteBuffer<?>> input)

Specified by:

readChunked in interface ChunkedMessageBodyReader<T>

isReadable

public boolean isReadable(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

read

public T read(Argument<T> type,
 MediaType mediaType,
 Headers httpHeaders,
 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(Argument<T> type,
 MediaType mediaType,
 Headers httpHeaders,
 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(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,
 MediaType mediaType,
 T object,
 MutableHeaders outgoingHeaders,
 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

writeTo

public ByteBuffer<?> writeTo(Argument<T> type,
 MediaType mediaType,
 T object,
 MutableHeaders outgoingHeaders,
 ByteBufferFactory<?,?> bufferFactory)
                      throws CodecException

Description copied from interface: MessageBodyWriter

Writes an object to the given 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

bufferFactory - A byte buffer factory

Returns:

The encoded byte buffer

Throws:

CodecException - If an error occurs decoding

writeTo

public void writeTo(@NonNull
 @NonNull HttpRequest<?> request,
 @NonNull
 @NonNull MutableHttpResponse<T> outgoingResponse,
 @NonNull
 @NonNull Argument<T> type,
 @NonNull
 @NonNull MediaType mediaType,
 @NonNull
 T object,
 @NonNull
 @NonNull NettyWriteContext nettyContext)
             throws CodecException

Description copied from interface: NettyBodyWriter

Write an object to the given context.

Specified by:

writeTo in interface NettyBodyWriter<T>

Parameters:

request - The associated request

outgoingResponse - The outgoing response.

type - The type

mediaType - The media type

object - The object to write

nettyContext - The netty context

Throws:

CodecException - If an error occurs decoding

createSpecific

public MessageBodyWriter<T> createSpecific(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

isBlocking

public boolean isBlocking()

Description copied from interface: MessageBodyWriter

true iff this closure can do a blocking read on the object it receives. For example, if this closure writes from an InputStream, that operation may be blocking and this method returns true.
Note that even when this is false, MessageBodyWriter.writeTo(Argument, MediaType, Object, MutableHeaders, OutputStream) may still block because the OutputStream that is passed as the write destination may still block.

Specified by:

isBlocking in interface MessageBodyWriter<T>

Returns:

Whether this writer may block