org.springframework.http.codec

Class ResourceHttpMessageWriter

java.lang.Object

org.springframework.http.codec.AbstractServerHttpMessageWriter<org.springframework.core.io.Resource>

org.springframework.http.codec.ResourceHttpMessageWriter

All Implemented Interfaces:

HttpMessageWriter<org.springframework.core.io.Resource>, ServerHttpMessageWriter<org.springframework.core.io.Resource>

public class ResourceHttpMessageWriter
extends AbstractServerHttpMessageWriter<org.springframework.core.io.Resource>

Implementation of HttpMessageWriter that can write Resources.

For a Resource reader simply use ResourceDecoder wrapped with DecoderHttpMessageReader.

Since:

5.0

Author:

Arjen Poutsma, Brian Clozel

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_RANGE_REQUEST_HINT

Constructor Summary

Constructors

Constructor and Description
ResourceHttpMessageWriter()
ResourceHttpMessageWriter(int bufferSize)

Method Summary

Modifier and Type	Method and Description
protected void	addHeaders(HttpHeaders headers, org.springframework.core.io.Resource resource, MediaType mediaType)
protected Map<String,Object>	resolveWriteHints(org.springframework.core.ResolvableType streamType, org.springframework.core.ResolvableType elementType, MediaType mediaType, ServerHttpRequest request) Invoked before writing the response to resolve hints by AbstractServerHttpMessageWriter.write(Publisher, ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse, Map).
reactor.core.publisher.Mono<Void>	write(org.reactivestreams.Publisher<? extends org.springframework.core.io.Resource> inputStream, org.springframework.core.ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage outputMessage, Map<String,Object> hints) Write an given object to the given output message.
reactor.core.publisher.Mono<Void>	write(org.reactivestreams.Publisher<? extends org.springframework.core.io.Resource> inputStream, org.springframework.core.ResolvableType streamType, org.springframework.core.ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, Map<String,Object> hints) Write a given object to the given output message with additional server related parameters which could be used to create some hints or set the response status for example.

Methods inherited from class org.springframework.http.codec.AbstractServerHttpMessageWriter

canWrite, getWritableMediaTypes

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_RANGE_REQUEST_HINT

public static final String HTTP_RANGE_REQUEST_HINT

Constructor Detail

ResourceHttpMessageWriter

public ResourceHttpMessageWriter()

ResourceHttpMessageWriter

public ResourceHttpMessageWriter(int bufferSize)

Method Detail

resolveWriteHints

protected Map<String,Object> resolveWriteHints(org.springframework.core.ResolvableType streamType,
                                               org.springframework.core.ResolvableType elementType,
                                               MediaType mediaType,
                                               ServerHttpRequest request)

Description copied from class: AbstractServerHttpMessageWriter

Invoked before writing the response to resolve hints by AbstractServerHttpMessageWriter.write(Publisher, ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse, Map).

Specified by:

resolveWriteHints in class AbstractServerHttpMessageWriter<org.springframework.core.io.Resource>

Parameters:

streamType - the original type used for the method return value. For annotation based controllers, the MethodParameter is available via ResolvableType.getSource().

elementType - the stream element type to process

mediaType - the content type to use when writing. May be null to indicate that the default content type of the converter must be used.

request - the current HTTP request

Returns:

additional information about how to write the body

write

public reactor.core.publisher.Mono<Void> write(org.reactivestreams.Publisher<? extends org.springframework.core.io.Resource> inputStream,
                                               org.springframework.core.ResolvableType elementType,
                                               MediaType mediaType,
                                               ReactiveHttpOutputMessage outputMessage,
                                               Map<String,Object> hints)

Description copied from interface: HttpMessageWriter

Write an given object to the given output message.

Specified by:

write in interface HttpMessageWriter<org.springframework.core.io.Resource>

Overrides:

write in class AbstractServerHttpMessageWriter<org.springframework.core.io.Resource>

Parameters:

inputStream - the input stream to write

elementType - the stream element type to process. This type must have previously been passed to the HttpMessageWriter.canWrite(org.springframework.core.ResolvableType, org.springframework.http.MediaType) canWrite} method of this interface, which must have returned true.

mediaType - the content type to use when writing, typically the value of an Accept header. May be null to indicate that the default content type of the converter must be used.

outputMessage - the message to write to

hints - additional information about how to write

Returns:

a Mono that indicates completion or error

write

public reactor.core.publisher.Mono<Void> write(org.reactivestreams.Publisher<? extends org.springframework.core.io.Resource> inputStream,
                                               org.springframework.core.ResolvableType streamType,
                                               org.springframework.core.ResolvableType elementType,
                                               MediaType mediaType,
                                               ServerHttpRequest request,
                                               ServerHttpResponse response,
                                               Map<String,Object> hints)

Description copied from interface: ServerHttpMessageWriter

Write a given object to the given output message with additional server related parameters which could be used to create some hints or set the response status for example.

Specified by:

write in interface ServerHttpMessageWriter<org.springframework.core.io.Resource>

Overrides:

write in class AbstractServerHttpMessageWriter<org.springframework.core.io.Resource>

streamType - the original type used for the method return value. For annotation based controllers, the MethodParameter is available via ResolvableType.getSource(). Can be null.

elementType - the stream element type to process

mediaType - the content type to use when writing. May be null to indicate that the default content type of the converter must be used.

request - the current HTTP request

response - the current HTTP response

Returns:

a Mono that indicates completion or error

addHeaders

protected void addHeaders(HttpHeaders headers,
                          org.springframework.core.io.Resource resource,
                          MediaType mediaType)