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
public class StreamFileEncoder
extends AbstractFileEncoder<io.micronaut.http.server.types.files.StreamedFile>

A ServletResponseEncoder for StreamedFile.

Since:

1.0.0

Author:

graemerocher

Constructor Summary

Constructors

Constructor	Description
StreamFileEncoder()
StreamFileEncoder(@Nullable ServletConfiguration servletConfiguration)

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)	Encode the given value.
Class<io.micronaut.http.server.types.files.StreamedFile>	getResponseType()

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)

StreamFileEncoder

public StreamFileEncoder()

Method Details

getResponseType

public Class<io.micronaut.http.server.types.files.StreamedFile> getResponseType()

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)

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