Package io.micronaut.servlet.http.encoders

Class StreamFileEncoder

java.lang.Object
io.micronaut.servlet.http.encoders.AbstractFileEncoder<io.micronaut.http.server.types.files.StreamedFile>
io.micronaut.servlet.http.encoders.StreamFileEncoder
All Implemented Interfaces:
ServletResponseEncoder<io.micronaut.http.server.types.files.StreamedFile>
@Singleton @Deprecated(forRemoval=true, since="5.1.0") public class StreamFileEncoder extends AbstractFileEncoder<io.micronaut.http.server.types.files.StreamedFile>
Deprecated, for removal: This API element is subject to removal in a future version.
Now unused, use a normal ResponseBodyWriter
A ServletResponseEncoder for StreamedFile.
Since:
1.0.0
Author:
graemerocher

  • Constructor Summary

    Constructors
    Constructor
    Description
    StreamFileEncoder()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    StreamFileEncoder(@Nullable ServletConfiguration servletConfiguration)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>>
    encode(@NonNull ServletExchange<?,?> exchange, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, @NonNull io.micronaut.http.server.types.files.StreamedFile value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Encode the given value.
    Class<io.micronaut.http.server.types.files.StreamedFile>
    getResponseType()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class io.micronaut.servlet.http.encoders.AbstractFileEncoder

    ifNotModified, setDateAndCacheHeaders, setDateHeader

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • StreamFileEncoder

      @Inject public StreamFileEncoder(@Nullable @Nullable ServletConfiguration servletConfiguration)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • StreamFileEncoder

      public StreamFileEncoder()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getResponseType

      public Class<io.micronaut.http.server.types.files.StreamedFile> getResponseType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      The response type.

    • encode

      public org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>> encode(@NonNull @NonNull ServletExchange<?,?> exchange, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, @NonNull @NonNull io.micronaut.http.server.types.files.StreamedFile value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ServletResponseEncoder
      Encode the given value.
      Parameters:
      exchange - The change
      annotationMetadata - The annotation metadata declared on the method
      value - The value to encode
      Returns:
      A publisher that emits completes with the response once the value has been encoded