Package io.micronaut.http.server.body

Class StreamFileBodyWriter

java.lang.Object
io.micronaut.http.server.body.StreamFileBodyWriter
All Implemented Interfaces:
io.micronaut.http.body.MessageBodyWriter<StreamedFile>, io.micronaut.http.body.ResponseBodyWriter<StreamedFile>
@Singleton @Internal public final class StreamFileBodyWriter extends Object implements io.micronaut.http.body.ResponseBodyWriter<StreamedFile>
Body writer for StreamedFiles.
Since:
4.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final HttpServerConfiguration.FileTypeHandlerConfiguration
    configuration
     

  • 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, io.micronaut.http.MutableHttpResponse<StreamedFile> outgoingResponse, io.micronaut.core.type.Argument<StreamedFile> type, io.micronaut.http.MediaType mediaType, StreamedFile object)
     
    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<StreamedFile> type, @NonNull io.micronaut.http.MediaType mediaType, StreamedFile object)
     
    void
    writeTo(io.micronaut.core.type.Argument<StreamedFile> type, io.micronaut.http.MediaType mediaType, StreamedFile object, 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

  • Method Details

    • write

      public io.micronaut.http.ByteBodyHttpResponse<?> write(@NonNull @NonNull io.micronaut.http.body.ByteBodyFactory bodyFactory, io.micronaut.http.HttpRequest<?> request, io.micronaut.http.MutableHttpResponse<StreamedFile> outgoingResponse, io.micronaut.core.type.Argument<StreamedFile> type, io.micronaut.http.MediaType mediaType, StreamedFile object) throws io.micronaut.http.codec.CodecException
      Specified by:
      write in interface io.micronaut.http.body.ResponseBodyWriter<StreamedFile>
      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<StreamedFile> type, @NonNull @NonNull io.micronaut.http.MediaType mediaType, StreamedFile object)
      Specified by:
      writePiece in interface io.micronaut.http.body.ResponseBodyWriter<StreamedFile>

    • writeTo

      public void writeTo(io.micronaut.core.type.Argument<StreamedFile> type, io.micronaut.http.MediaType mediaType, StreamedFile object, io.micronaut.core.type.MutableHeaders outgoingHeaders, OutputStream outputStream) throws io.micronaut.http.codec.CodecException
      Specified by:
      writeTo in interface io.micronaut.http.body.MessageBodyWriter<StreamedFile>
      Throws:
      io.micronaut.http.codec.CodecException

    • 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)