org.springframework.http.codec

Class AbstractServerHttpMessageWriter<T>

java.lang.Object

org.springframework.http.codec.AbstractServerHttpMessageWriter<T>

All Implemented Interfaces:

HttpMessageWriter<T>, ServerHttpMessageWriter<T>

Direct Known Subclasses:

Jackson2ServerHttpMessageWriter, ResourceHttpMessageWriter

public abstract class AbstractServerHttpMessageWriter<T>
extends Object
implements ServerHttpMessageWriter<T>

HttpMessageWriter wrapper that implements ServerHttpMessageWriter in order to allow providing hints to the nested writer or setting the response status for example, by implementing resolveWriteHints(ResolvableType, ResolvableType, MediaType, ServerHttpRequest).

Since:

5.0

Author:

Sebastien Deleuze

Constructor Summary

Constructors

Constructor and Description
AbstractServerHttpMessageWriter(HttpMessageWriter<T> writer)

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(org.springframework.core.ResolvableType elementType, MediaType mediaType) Indicates whether the given class can be written by this converter.
List<MediaType>	getWritableMediaTypes() Return the list of MediaType objects that can be written by this converter.
protected abstract 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 write(Publisher, ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse, Map).
reactor.core.publisher.Mono<Void>	write(org.reactivestreams.Publisher<? extends T> 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 T> 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 java.lang.Object

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

Constructor Detail

AbstractServerHttpMessageWriter

public AbstractServerHttpMessageWriter(HttpMessageWriter<T> writer)

Method Detail

canWrite

public boolean canWrite(org.springframework.core.ResolvableType elementType,
                        MediaType mediaType)

Description copied from interface: HttpMessageWriter

Indicates whether the given class can be written by this converter.

Specified by:

canWrite in interface HttpMessageWriter<T>

Parameters:

elementType - the stream element type to test for writability

mediaType - the media type to write, can be null if not specified. Typically the value of an Accept header.

Returns:

true if writable; false otherwise

getWritableMediaTypes

public List<MediaType> getWritableMediaTypes()

Description copied from interface: HttpMessageWriter

Return the list of MediaType objects that can be written by this converter.

Specified by:

getWritableMediaTypes in interface HttpMessageWriter<T>

Returns:

the list of supported readable media types

write

public reactor.core.publisher.Mono<Void> write(org.reactivestreams.Publisher<? extends T> 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<T>

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 T> 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<T>

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

resolveWriteHints

protected abstract 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 write(Publisher, ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse, Map).

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