Package io.micronaut.http.server.body

Class SystemFileBodyWriter

java.lang.Object

io.micronaut.http.server.body.SystemFileBodyWriter

All Implemented Interfaces:

io.micronaut.http.body.MessageBodyWriter<SystemFile>, io.micronaut.http.body.ResponseBodyWriter<SystemFile>

@Singleton
@Internal
public final class SystemFileBodyWriter
extends Object
implements io.micronaut.http.body.ResponseBodyWriter<SystemFile>

Body writer for SystemFiles.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final HttpServerConfiguration.FileTypeHandlerConfiguration	configuration

Constructor Summary

Constructors

Constructor	Description
SystemFileBodyWriter(HttpServerConfiguration.FileTypeHandlerConfiguration configuration, ExecutorService ioExecutor)

Method Summary

Modifier and Type	Method	Description
protected boolean	handleIfModifiedAndHeaders(io.micronaut.http.HttpRequest<?> request, io.micronaut.http.MutableHttpResponse<?> response, FileCustomizableResponseType systemFile, io.micronaut.http.MutableHttpResponse<?> nettyResponse)
protected io.micronaut.http.ByteBodyHttpResponse<?>	notModified(io.micronaut.http.body.ByteBodyFactory bodyFactory, io.micronaut.http.MutableHttpResponse<?> originalResponse)
protected void	setDateAndCacheHeaders(io.micronaut.http.MutableHttpResponse response, long lastModified)
protected void	setDateHeader(io.micronaut.http.MutableHttpResponse response)
io.micronaut.http.ByteBodyHttpResponse<?>	write(@NonNull io.micronaut.http.body.ByteBodyFactory bodyFactory, io.micronaut.http.HttpRequest<?> request, @NonNull io.micronaut.http.MutableHttpResponse<SystemFile> httpResponse, @NonNull io.micronaut.core.type.Argument<SystemFile> type, @NonNull io.micronaut.http.MediaType mediaType, SystemFile object)
io.micronaut.http.ByteBodyHttpResponse<?>	write(@NonNull io.micronaut.http.body.ByteBodyFactory bodyFactory, io.micronaut.http.HttpRequest<?> request, io.micronaut.http.MutableHttpResponse<SystemFile> response, SystemFile systemFile)
io.micronaut.http.body.CloseableByteBody	writePiece(@NonNull io.micronaut.http.body.ByteBodyFactory bodyFactory, @NonNull io.micronaut.http.HttpRequest<?> request, @NonNull io.micronaut.http.HttpResponse<?> response, @NonNull io.micronaut.core.type.Argument<SystemFile> type, @NonNull io.micronaut.http.MediaType mediaType, SystemFile object)
@NonNull io.micronaut.http.body.CloseableByteBody	writePiece(@NonNull io.micronaut.http.body.ByteBodyFactory bodyFactory, SystemFile object)
void	writeTo(io.micronaut.core.type.Argument<SystemFile> type, io.micronaut.http.MediaType mediaType, SystemFile file, io.micronaut.core.type.MutableHeaders outgoingHeaders, OutputStream outputStream)

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

Field Details

configuration

protected final HttpServerConfiguration.FileTypeHandlerConfiguration configuration

Constructor Details

SystemFileBodyWriter

public SystemFileBodyWriter(HttpServerConfiguration.FileTypeHandlerConfiguration configuration,
 @Named("blocking")
 ExecutorService ioExecutor)

Method Details

writeTo

public void writeTo(io.micronaut.core.type.Argument<SystemFile> type,
 io.micronaut.http.MediaType mediaType,
 SystemFile file,
 io.micronaut.core.type.MutableHeaders outgoingHeaders,
 OutputStream outputStream)
             throws io.micronaut.http.codec.CodecException

Specified by:

writeTo in interface io.micronaut.http.body.MessageBodyWriter<SystemFile>

Throws:

io.micronaut.http.codec.CodecException

write

public io.micronaut.http.ByteBodyHttpResponse<?> write(@NonNull
 @NonNull io.micronaut.http.body.ByteBodyFactory bodyFactory,
 io.micronaut.http.HttpRequest<?> request,
 @NonNull
 @NonNull io.micronaut.http.MutableHttpResponse<SystemFile> httpResponse,
 @NonNull
 @NonNull io.micronaut.core.type.Argument<SystemFile> type,
 @NonNull
 @NonNull io.micronaut.http.MediaType mediaType,
 SystemFile object)
                                                throws io.micronaut.http.codec.CodecException

Specified by:

write in interface io.micronaut.http.body.ResponseBodyWriter<SystemFile>

Throws:

io.micronaut.http.codec.CodecException

write

public io.micronaut.http.ByteBodyHttpResponse<?> write(@NonNull
 @NonNull io.micronaut.http.body.ByteBodyFactory bodyFactory,
 io.micronaut.http.HttpRequest<?> request,
 io.micronaut.http.MutableHttpResponse<SystemFile> response,
 SystemFile systemFile)
                                                throws io.micronaut.http.codec.CodecException

Throws:

io.micronaut.http.codec.CodecException

writePiece

public io.micronaut.http.body.CloseableByteBody writePiece(@NonNull
 @NonNull io.micronaut.http.body.ByteBodyFactory bodyFactory,
 @NonNull
 @NonNull io.micronaut.http.HttpRequest<?> request,
 @NonNull
 @NonNull io.micronaut.http.HttpResponse<?> response,
 @NonNull
 @NonNull io.micronaut.core.type.Argument<SystemFile> type,
 @NonNull
 @NonNull io.micronaut.http.MediaType mediaType,
 SystemFile object)

Specified by:

writePiece in interface io.micronaut.http.body.ResponseBodyWriter<SystemFile>

writePiece

@NonNull
public @NonNull io.micronaut.http.body.CloseableByteBody writePiece(@NonNull
 @NonNull io.micronaut.http.body.ByteBodyFactory bodyFactory,
 SystemFile object)

handleIfModifiedAndHeaders

protected boolean handleIfModifiedAndHeaders(io.micronaut.http.HttpRequest<?> request,
 io.micronaut.http.MutableHttpResponse<?> response,
 FileCustomizableResponseType systemFile,
 io.micronaut.http.MutableHttpResponse<?> nettyResponse)

setDateAndCacheHeaders

protected void setDateAndCacheHeaders(io.micronaut.http.MutableHttpResponse response,
 long lastModified)

Parameters:

response - The Http response

lastModified - The last modified

setDateHeader

protected void setDateHeader(io.micronaut.http.MutableHttpResponse response)

Parameters:

response - The Http response

notModified

protected io.micronaut.http.ByteBodyHttpResponse<?> notModified(io.micronaut.http.body.ByteBodyFactory bodyFactory,
 io.micronaut.http.MutableHttpResponse<?> originalResponse)