Spring Framework 6.1.4 · org.springframework.web.reactive.result.view.ViewResolutionResultHandler

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

Void, void, or no value -- default view name
String -- view name unless @ModelAttribute-annotated
View -- View to render with
Model -- attributes to add to the model
Map -- attributes to add to the model
Rendering -- use case driven API for view resolution
@ModelAttribute -- attribute for the model
Non-simple value -- attribute for the model

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 or any non-simple value type as a model attribute while other result handlers may interpret the same otherwise based on the presence of annotations, e.g. for @ResponseBody.

Field Summary

Modifier and Type	Field and Description
private final List<View>	defaultViews
private static final Object	NO_VALUE
private static final Mono<Object>	NO_VALUE_MONO
private final List<ViewResolver>	viewResolvers

Inherited from org.springframework.web.reactive.result.HandlerResultHandlerSupport:: logger

Constructor Summary

Access	Constructor and Description
public	ViewResolutionResultHandler(List<ViewResolver> the resolver to use viewResolvers, RequestedContentTypeResolver to determine the requested content type contentTypeResolver) Basic constructor with a default `ReactiveAdapterRegistry`.
public	ViewResolutionResultHandler(List<ViewResolver> the view resolver to use viewResolvers, RequestedContentTypeResolver to determine the requested content type contentTypeResolver, ReactiveAdapterRegistry for adaptation to reactive types registry) Constructor with an `ReactiveAdapterRegistry` instance.

Method Summary

Modifier and Type	Method and Description
private String	getDefaultViewName(ServerWebExchange exchange) Select a default view name when a controller did not specify it.
public List<View>	getDefaultViews() Return the configured default `View`'s.
private List<MediaType>	getMediaTypes(List<View> views)
private String	getNameForReturnValue(MethodParameter returnType)
public List<ViewResolver>	getViewResolvers() Return a read-only list of view resolvers.
public Mono<Void>	handleResult(ServerWebExchange current server exchange exchange, HandlerResult the result from the handling result) Implements org.springframework.web.reactive.HandlerResultHandler.handleResult. Process the given result modifying response headers and/or writing data to the response.
private boolean	hasModelAnnotation(MethodParameter parameter)
private Mono<? extends Void>	render(List<View> views, Map<String, Object> model, BindingContext bindingContext, ServerWebExchange exchange)
private Mono<? extends Void>	renderWith(View view, Map<String, Object> model, MediaType mediaType, ServerWebExchange exchange, BindingContext bindingContext)
private Mono<List<View>>	resolveViews(String viewName, Locale locale)
public void	setDefaultViews(List<View> defaultViews) Set the default views to consider always when resolving view names and trying to satisfy the best matching content type.
public boolean	supports(HandlerResult the result object to check result) Implements org.springframework.web.reactive.HandlerResultHandler.supports. Whether this handler supports the given `HandlerResult`.

Inherited from org.springframework.web.reactive.result.HandlerResultHandlerSupport:: getAdapter getAdapterRegistry getContentTypeResolver getOrder selectMediaType selectMediaType setOrder

Field Detail

defaultViews	back to summary
private final List<View> defaultViews

NO_VALUE	back to summary
private static final Object NO_VALUE

NO_VALUE_MONO	back to summary
private static final Mono<Object> NO_VALUE_MONO

viewResolvers	back to summary
private final List<ViewResolver> viewResolvers

Constructor Detail

ViewResolutionResultHandler back to summary

ViewResolutionResultHandler	back to summary
public ViewResolutionResultHandler(List<ViewResolver> viewResolvers, RequestedContentTypeResolver contentTypeResolver) Basic constructor with a default `ReactiveAdapterRegistry`. Parameters viewResolvers:List<ViewResolver> the resolver to use contentTypeResolver:RequestedContentTypeResolver to determine the requested content type

public ViewResolutionResultHandler(List<ViewResolver> viewResolvers, RequestedContentTypeResolver contentTypeResolver)

Basic constructor with a default ReactiveAdapterRegistry.

Parameters

viewResolvers:List<ViewResolver>: the resolver to use
contentTypeResolver:RequestedContentTypeResolver: to determine the requested content type

ViewResolutionResultHandler back to summary

ViewResolutionResultHandler	back to summary
public ViewResolutionResultHandler(List<ViewResolver> viewResolvers, RequestedContentTypeResolver contentTypeResolver, ReactiveAdapterRegistry registry) Constructor with an `ReactiveAdapterRegistry` instance. Parameters viewResolvers:List<ViewResolver> the view resolver to use contentTypeResolver:RequestedContentTypeResolver to determine the requested content type registry:ReactiveAdapterRegistry for adaptation to reactive types

public ViewResolutionResultHandler(List<ViewResolver> viewResolvers, RequestedContentTypeResolver contentTypeResolver, ReactiveAdapterRegistry registry)

Constructor with an ReactiveAdapterRegistry instance.

Parameters

viewResolvers:List<ViewResolver>: the view resolver to use
contentTypeResolver:RequestedContentTypeResolver: to determine the requested content type
registry:ReactiveAdapterRegistry: for adaptation to reactive types

Method Detail

getDefaultViewName	back to summary
private String getDefaultViewName(ServerWebExchange exchange) Select a default view name when a controller did not specify it. Use the request path the leading and trailing slash stripped.

getDefaultViews	back to summary
public List<View> getDefaultViews() Return the configured default `View`'s.

getMediaTypes	back to summary
private List<MediaType> getMediaTypes(List<View> views)

getNameForReturnValue	back to summary
private String getNameForReturnValue(MethodParameter returnType)

getViewResolvers	back to summary
public List<ViewResolver> getViewResolvers() Return a read-only list of view resolvers.

handleResult back to summary

handleResult	back to summary
public Mono<Void> handleResult(ServerWebExchange exchange, HandlerResult result) Implements org.springframework.web.reactive.HandlerResultHandler.handleResult. Doc from org.springframework.web.reactive.HandlerResultHandler.handleResult. Process the given result modifying response headers and/or writing data to the response. Parameters exchange:ServerWebExchange current server exchange result:HandlerResult the result from the handling Returns:Mono<Void> `Mono<Void>` to indicate when request handling is complete. Annotations @Override @SuppressWarnings:unchecked

public Mono<Void> handleResult(ServerWebExchange exchange, HandlerResult result)

Implements org.springframework.web.reactive.HandlerResultHandler.handleResult.

Doc from org.springframework.web.reactive.HandlerResultHandler.handleResult.

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

Parameters

exchange:ServerWebExchange: current server exchange
result:HandlerResult: the result from the handling

Returns:Mono<Void>

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

Annotations

@Override
@SuppressWarnings:unchecked

hasModelAnnotation	back to summary
private boolean hasModelAnnotation(MethodParameter parameter)

render	back to summary
private Mono<? extends Void> render(List<View> views, Map<String, Object> model, BindingContext bindingContext, ServerWebExchange exchange)

renderWith	back to summary
private Mono<? extends Void> renderWith(View view, Map<String, Object> model, MediaType mediaType, ServerWebExchange exchange, BindingContext bindingContext)

resolveViews	back to summary
private Mono<List<View>> resolveViews(String viewName, Locale locale)

setDefaultViews	back to summary
public void setDefaultViews(List<View> defaultViews) Set the default views to consider always when resolving view names and trying to satisfy the best matching content type.

supports back to summary

supports	back to summary
public boolean supports(HandlerResult result) Implements org.springframework.web.reactive.HandlerResultHandler.supports. Doc from org.springframework.web.reactive.HandlerResultHandler.supports. Whether this handler supports the given `HandlerResult`. Parameters result:HandlerResult the result object to check Returns:boolean whether this object can use the given result Annotations @Override

public boolean supports(HandlerResult result)

Implements org.springframework.web.reactive.HandlerResultHandler.supports.

Doc from org.springframework.web.reactive.HandlerResultHandler.supports.

Whether this handler supports the given HandlerResult.

Parameters

result:HandlerResult: the result object to check

Returns:boolean

whether this object can use the given result

Annotations

@Override

public Class ViewResolutionResultHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail