Class WritableBodyWriter

java.lang.Object

io.micronaut.http.body.WritableBodyWriter

All Implemented Interfaces:

ChunkedMessageBodyReader<Writable>, MessageBodyHandler<Writable>, MessageBodyReader<Writable>, MessageBodyWriter<Writable>, ResponseBodyWriter<Writable>, TypedMessageBodyHandler<Writable>, TypedMessageBodyReader<Writable>, TypedMessageBodyWriter<Writable>

@Singleton
public final class WritableBodyWriter
extends Object
implements TypedMessageBodyHandler<Writable>, ChunkedMessageBodyReader<Writable>, ResponseBodyWriter<Writable>

Body writer for Writables.

Since:

4.0.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor	Description
WritableBodyWriter(ApplicationConfiguration applicationConfiguration)

Method Summary

Modifier and Type	Method	Description
Argument<Writable>	getType()
boolean	isBlocking()	true iff this closure can do a blocking read on the object it receives.
Writable	read(Argument<Writable> type, @Nullable MediaType mediaType, Headers httpHeaders, ByteBuffer<?> byteBuffer)	Reads an object from the given byte buffer.
Writable	read(Argument<Writable> type, @Nullable MediaType mediaType, Headers httpHeaders, InputStream inputStream)	Reads an object from the given byte buffer.
Publisher<? extends Writable>	readChunked(Argument<Writable> type, @Nullable MediaType mediaType, Headers httpHeaders, Publisher<ByteBuffer<?>> input)
CloseableByteBody	writePiece(ByteBodyFactory bodyFactory, HttpRequest<?> request, HttpResponse<?> response, Argument<Writable> type, MediaType mediaType, Writable object)	Write a piece of a larger response, e.g.
void	writeTo(Argument<Writable> type, MediaType mediaType, Writable object, MutableHeaders outgoingHeaders, OutputStream outputStream)	Writes an object to the given output stream.

Methods inherited from class Object

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

Methods inherited from interface MessageBodyWriter

createSpecific, writeTo

Methods inherited from interface ResponseBodyWriter

write

Methods inherited from interface TypedMessageBodyReader

isReadable

Methods inherited from interface TypedMessageBodyWriter

isWriteable

Constructor Details

WritableBodyWriter

public WritableBodyWriter(ApplicationConfiguration applicationConfiguration)

Method Details

getType

public Argument<Writable> getType()

Specified by:

getType in interface TypedMessageBodyHandler<Writable>

Specified by:

getType in interface TypedMessageBodyReader<Writable>

Specified by:

getType in interface TypedMessageBodyWriter<Writable>

Returns:

The body type.

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<Writable>

Returns:

Whether this writer may block

writeTo

public void writeTo(Argument<Writable> type,
 MediaType mediaType,
 Writable 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<Writable>

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

readChunked

public Publisher<? extends Writable> readChunked(Argument<Writable> type,
 @Nullable MediaType mediaType,
 Headers httpHeaders,
 Publisher<ByteBuffer<?>> input)

Specified by:

readChunked in interface ChunkedMessageBodyReader<Writable>

read

public Writable read(Argument<Writable> type,
 @Nullable 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<Writable>

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 Writable read(Argument<Writable> type,
 @Nullable 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<Writable>

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

writePiece

public CloseableByteBody writePiece(ByteBodyFactory bodyFactory,
 HttpRequest<?> request,
 HttpResponse<?> response,
 Argument<Writable> type,
 MediaType mediaType,
 Writable 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<Writable>

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