org.springframework.web.reactive.result.view

Class HttpMessageWriterView

java.lang.Object

org.springframework.web.reactive.result.view.HttpMessageWriterView

All Implemented Interfaces:

View

public class HttpMessageWriterView
extends java.lang.Object
implements View

A View that delegates to an HttpMessageWriter.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<MediaType>	mediaTypes
private HttpMessageWriter<?>	messageWriter
private java.util.Set<java.lang.String>	modelKeys

Constructor Summary

Constructors

Constructor and Description
HttpMessageWriterView(Encoder<?> encoder) Create a View with the given Encoder wrapping it as an EncoderHttpMessageWriter.
HttpMessageWriterView(HttpMessageWriter<?> messageWriter) Create a View that delegates to the given message messageWriter.

Method Summary

Modifier and Type	Method and Description
private <T> <any>	applyMessageWriter(java.lang.Object value, MediaType contentType, ServerWebExchange exchange)
protected java.lang.Object	extractObjectToRender(java.util.Map<java.lang.String,?> model)
HttpMessageWriter<?>	getMessageWriter() Return the configured message messageWriter.
java.util.Set<java.lang.String>	getModelKeys() Return the configured model keys.
java.util.List<MediaType>	getSupportedMediaTypes() Return the list of media types this View supports, or an empty list.
protected boolean	isEligibleAttribute(java.lang.String attributeName, java.lang.Object attributeValue) Whether the given model attribute key-value pair is eligible for encoding.
<any>	render(java.util.Map<java.lang.String,?> model, MediaType contentType, ServerWebExchange exchange) Render the view based on the given HandlerResult.
void	setModelKeys(java.util.Set<java.lang.String> modelKeys) By default model attributes are filtered with HttpMessageWriter.canWrite(org.springframework.core.ResolvableType, org.springframework.http.MediaType) to find the ones that can be rendered.

Methods inherited from class java.lang.Object

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

Field Detail

messageWriter

private final HttpMessageWriter<?> messageWriter

modelKeys

private final java.util.Set<java.lang.String> modelKeys

mediaTypes

private final java.util.List<MediaType> mediaTypes

Constructor Detail

HttpMessageWriterView

public HttpMessageWriterView(Encoder<?> encoder)

Create a View with the given Encoder wrapping it as an EncoderHttpMessageWriter.

HttpMessageWriterView

public HttpMessageWriterView(HttpMessageWriter<?> messageWriter)

Create a View that delegates to the given message messageWriter.

Method Detail

getMessageWriter

public HttpMessageWriter<?> getMessageWriter()

Return the configured message messageWriter.

setModelKeys

public void setModelKeys(java.util.Set<java.lang.String> modelKeys)

By default model attributes are filtered with HttpMessageWriter.canWrite(org.springframework.core.ResolvableType, org.springframework.http.MediaType) to find the ones that can be rendered. Use this property to further narrow the list and consider only attribute(s) under specific model key(s).

If more than one matching attribute is found, than a Map is rendered, or if the Encoder does not support rendering a Map then an exception is raised.

getModelKeys

public final java.util.Set<java.lang.String> getModelKeys()

Return the configured model keys.

getSupportedMediaTypes

public java.util.List<MediaType> getSupportedMediaTypes()

Description copied from interface: View

Return the list of media types this View supports, or an empty list.

Specified by:

getSupportedMediaTypes in interface View

render

public <any> render(java.util.Map<java.lang.String,?> model,
                    MediaType contentType,
                    ServerWebExchange exchange)

Description copied from interface: View

Render the view based on the given HandlerResult. Implementations can access and use the model or only a specific attribute in it.

Specified by:

render in interface View

Parameters:

model - Map with name Strings as keys and corresponding model objects as values (Map can also be null in case of empty model)

contentType - the content type selected to render with which should match one of the supported media types.

exchange - the current exchange

Returns:

Mono to represent when and if rendering succeeds

extractObjectToRender

protected java.lang.Object extractObjectToRender(java.util.Map<java.lang.String,?> model)

isEligibleAttribute

protected boolean isEligibleAttribute(java.lang.String attributeName,
                                      java.lang.Object attributeValue)

Whether the given model attribute key-value pair is eligible for encoding.

The default implementation checks against the configured model keys and whether the Encoder supports the value type.

applyMessageWriter

private <T> <any> applyMessageWriter(java.lang.Object value,
                                     MediaType contentType,
                                     ServerWebExchange exchange)