org.springframework.web.reactive.result.view

Class ViewResolutionResultHandler

java.lang.Object

org.springframework.web.reactive.result.AbstractHandlerResultHandler

org.springframework.web.reactive.result.view.ViewResolutionResultHandler

All Implemented Interfaces:

Ordered, HandlerResultHandler

public class ViewResolutionResultHandler
extends AbstractHandlerResultHandler
implements HandlerResultHandler, Ordered

HandlerResultHandler that encapsulates the view resolution algorithm supporting the following return types:

• String-based view name
• Reference to a View
• Model
• Map
• Return types annotated with @ModelAttribute
• Non-simple return types are treated as a model attribute

A String-based view name is resolved through the configured ViewResolver instances into a View to use for rendering. If a view is left unspecified (e.g. by returning null or a model-related return value), a default view name is selected.

By default this resolver is ordered at Ordered.LOWEST_PRECEDENCE and generally needs to be late in the order since it interprets any String return value as a view name while others may interpret the same otherwise based on annotations (e.g. for @ResponseBody).

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<View>	defaultViews
private static java.lang.Object	NO_VALUE
private static <any>	NO_VALUE_MONO
private HttpRequestPathHelper	pathHelper
private java.util.List<ViewResolver>	viewResolvers

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ViewResolutionResultHandler(java.util.List<ViewResolver> resolvers, RequestedContentTypeResolver contentTypeResolver) Constructor with ViewResolvers and a RequestedContentTypeResolver.
ViewResolutionResultHandler(java.util.List<ViewResolver> resolvers, RequestedContentTypeResolver contentTypeResolver, ReactiveAdapterRegistry adapterRegistry) Constructor with ViewResolvers tand a ConversionService.

Method Summary

Modifier and Type	Method and Description
private void	addBindingResult(HandlerResult result, ServerWebExchange exchange)
protected java.lang.String	getDefaultViewName(HandlerResult result, ServerWebExchange exchange) Select a default view name when a controller leaves the view unspecified.
java.util.List<View>	getDefaultViews() Return the configured default View's.
private java.util.List<MediaType>	getMediaTypes(java.util.List<View> views)
private java.lang.String	getNameForReturnValue(java.lang.Class<?> returnValueType, MethodParameter returnType) Return the name of a model attribute return value based on the method @ModelAttribute annotation, if present, or derived from the type of the return value otherwise.
java.util.List<ViewResolver>	getViewResolvers() Return a read-only list of view resolvers.
<any>	handleResult(ServerWebExchange exchange, HandlerResult result) Process the given result modifying response headers and/or writing data to the response.
private boolean	hasModelAttributeAnnotation(HandlerResult result)
private boolean	isBindingCandidate(java.lang.String name, java.lang.Object value)
private boolean	isSupportedType(java.lang.Class<?> clazz)
private <any>	render(java.util.List<View> views, java.util.Map<java.lang.String,java.lang.Object> model, ServerWebExchange exchange)
private <any>	resolveAsyncAttributes(java.util.Map<java.lang.String,java.lang.Object> model)
private <any>	resolveViews(java.lang.String viewName, java.util.Locale locale)
void	setDefaultViews(java.util.List<View> defaultViews) Set the default views to consider always when resolving view names and trying to satisfy the best matching content type.
boolean	supports(HandlerResult result) Whether this handler supports the given HandlerResult.

Methods inherited from class org.springframework.web.reactive.result.AbstractHandlerResultHandler

getAdapterRegistry, getContentTypeResolver, getOrder, selectMediaType, setOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.Ordered

getOrder

Field Detail

NO_VALUE

private static final java.lang.Object NO_VALUE

NO_VALUE_MONO

private static final <any> NO_VALUE_MONO

viewResolvers

private final java.util.List<ViewResolver> viewResolvers

defaultViews

private final java.util.List<View> defaultViews

pathHelper

private final HttpRequestPathHelper pathHelper

Constructor Detail

ViewResolutionResultHandler

public ViewResolutionResultHandler(java.util.List<ViewResolver> resolvers,
                                   RequestedContentTypeResolver contentTypeResolver)

Constructor with ViewResolvers and a RequestedContentTypeResolver.

Parameters:

resolvers - the resolver to use

contentTypeResolver - for resolving the requested content type

ViewResolutionResultHandler

public ViewResolutionResultHandler(java.util.List<ViewResolver> resolvers,
                                   RequestedContentTypeResolver contentTypeResolver,
                                   ReactiveAdapterRegistry adapterRegistry)

Constructor with ViewResolvers tand a ConversionService.

Parameters:

resolvers - the resolver to use

contentTypeResolver - for resolving the requested content type

adapterRegistry - for adapting from other reactive types (e.g. rx.Single) to Mono

Method Detail

getViewResolvers

public java.util.List<ViewResolver> getViewResolvers()

Return a read-only list of view resolvers.

setDefaultViews

public void setDefaultViews(java.util.List<View> defaultViews)

Set the default views to consider always when resolving view names and trying to satisfy the best matching content type.

getDefaultViews

public java.util.List<View> getDefaultViews()

Return the configured default View's.

supports

public boolean supports(HandlerResult result)

Description copied from interface: HandlerResultHandler

Whether this handler supports the given HandlerResult.

Specified by:

supports in interface HandlerResultHandler

Parameters:

result - result object to check

Returns:

whether or not this object can use the given result

hasModelAttributeAnnotation

private boolean hasModelAttributeAnnotation(HandlerResult result)

isSupportedType

private boolean isSupportedType(java.lang.Class<?> clazz)

handleResult

public <any> handleResult(ServerWebExchange exchange,
                          HandlerResult result)

Description copied from interface: HandlerResultHandler

Process the given result modifying response headers and/or writing data to the response.

Specified by:

handleResult in interface HandlerResultHandler

Parameters:

exchange - current server exchange

result - the result from the handling

Returns:

Mono<Void> to indicate when request handling is complete.

getDefaultViewName

protected java.lang.String getDefaultViewName(HandlerResult result,
                                              ServerWebExchange exchange)

Select a default view name when a controller leaves the view unspecified. The default implementation strips the leading and trailing slash from the as well as any extension and uses that as the view name.

resolveViews

private <any> resolveViews(java.lang.String viewName,
                           java.util.Locale locale)

getNameForReturnValue

private java.lang.String getNameForReturnValue(java.lang.Class<?> returnValueType,
                                               MethodParameter returnType)

Return the name of a model attribute return value based on the method @ModelAttribute annotation, if present, or derived from the type of the return value otherwise.

resolveAsyncAttributes

private <any> resolveAsyncAttributes(java.util.Map<java.lang.String,java.lang.Object> model)

addBindingResult

private void addBindingResult(HandlerResult result,
                              ServerWebExchange exchange)

isBindingCandidate

private boolean isBindingCandidate(java.lang.String name,
                                   java.lang.Object value)

render

private <any> render(java.util.List<View> views,
                     java.util.Map<java.lang.String,java.lang.Object> model,
                     ServerWebExchange exchange)

getMediaTypes

private java.util.List<MediaType> getMediaTypes(java.util.List<View> views)