Package io.micronaut.http.server.body

Class FileBodyWriter

java.lang.Object

io.micronaut.http.server.body.FileBodyWriter

All Implemented Interfaces:

MessageBodyWriter<File>, ResponseBodyWriter<File>

@Internal
@Singleton
public final class FileBodyWriter
extends Object
implements ResponseBodyWriter<File>

Body writer for Files.

Since:

4.0.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor	Description
FileBodyWriter(SystemFileBodyWriter systemFileBodyWriter)

Method Summary

Modifier and Type	Method	Description
ByteBodyHttpResponse<?>	write(@NonNull ByteBodyFactory bodyFactory, HttpRequest<?> request, MutableHttpResponse<File> outgoingResponse, Argument<File> type, MediaType mediaType, File object)	Writes an object as a ByteBodyHttpResponse.
CloseableByteBody	writePiece(@NonNull ByteBodyFactory bodyFactory, @NonNull HttpRequest<?> request, @NonNull HttpResponse<?> response, @NonNull Argument<File> type, @NonNull MediaType mediaType, File object)	Write a piece of a larger response, e.g.
void	writeTo(Argument<File> type, MediaType mediaType, File 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

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

createSpecific, isBlocking, isWriteable, writeTo

Constructor Details

FileBodyWriter

public FileBodyWriter(SystemFileBodyWriter systemFileBodyWriter)

Method Details

write

public ByteBodyHttpResponse<?> write(@NonNull
 @NonNull ByteBodyFactory bodyFactory,
 HttpRequest<?> request,
 MutableHttpResponse<File> outgoingResponse,
 Argument<File> type,
 MediaType mediaType,
 File object)
                              throws CodecException

Description copied from interface: ResponseBodyWriter

Writes an object as a ByteBodyHttpResponse.

Specified by:

write in interface ResponseBodyWriter<File>

Parameters:

bodyFactory - The buffer factory

request - The request

outgoingResponse - The response

type - The response body type

mediaType - The media type

object - The object to write

Returns:

A ByteBodyHttpResponse with the response bytes

Throws:

CodecException - If an error occurs encoding

writePiece

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

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

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

writeTo

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

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