org.thymeleaf.spring5.view.reactive

Class ThymeleafReactiveViewResolver

Object

org.springframework.web.reactive.result.view.ViewResolverSupport

org.thymeleaf.spring5.view.reactive.ThymeleafReactiveViewResolver

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.reactive.result.view.ViewResolver

public class ThymeleafReactiveViewResolver
extends org.springframework.web.reactive.result.view.ViewResolverSupport
implements org.springframework.web.reactive.result.view.ViewResolver

Implementation of the Spring WebFlux ViewResolver interface.

View resolvers execute after the controller ends its execution. They receive the name of the view to be processed and are in charge of creating (and configuring) the corresponding View object for it.

The View implementations managed by this class are of type ThymeleafReactiveView.

Since:

3.0.3

Author:

Daniel Fernández

See Also:

ThymeleafReactiveView, ISpringWebFluxTemplateEngine

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORWARD_URL_PREFIX
static String	REDIRECT_URL_PREFIX Prefix to be used in view names (returned by controllers) for specifying an HTTP redirect.

Fields inherited from class org.springframework.web.reactive.result.view.ViewResolverSupport

DEFAULT_CONTENT_TYPE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ThymeleafReactiveViewResolver() Create an instance of ThymeleafReactiveViewResolver.

Method Summary

Modifier and Type	Method and Description
void	addStaticVariable(String name, Object value) Add a new static variable.
protected boolean	canHandle(String viewName, Locale locale)
boolean	getAlwaysProcessRedirectAndForward() Return whether this view resolver should always process forwards and redirects independently of the value of the viewNames property.
String[]	getExcludedViewNames()
int	getOrder() Returns the order in which this view resolver will be queried.
Function<String,org.springframework.web.reactive.result.view.RedirectView>	getRedirectViewProvider() Returns the provider function for creating RedirectView instances when a redirect request is passed to the view resolver.
int	getResponseMaxChunkSizeBytes() Return the maximum size (in bytes) allowed for the chunks (DataBuffer) that are produced by the Thymeleaf engine and passed to the server as output.
Map<String,Object>	getStaticVariables() Return the static variables, which will be available at the context every time a view resolved by this ViewResolver is processed.
ISpringWebFluxTemplateEngine	getTemplateEngine() Returns the Thymeleaf template engine instance (implementation of ISpringWebFluxTemplateEngine to be used for the execution of templates.
protected Class<? extends ThymeleafReactiveView>	getViewClass()
String[]	getViewNames()
protected reactor.core.publisher.Mono<org.springframework.web.reactive.result.view.View>	loadView(String viewName, Locale locale)
reactor.core.publisher.Mono<org.springframework.web.reactive.result.view.View>	resolveViewName(String viewName, Locale locale)
void	setAlwaysProcessRedirectAndForward(boolean alwaysProcessRedirectAndForward) Set whether this view resolver should always process forwards and redirects independently of the value of the viewNames property.
void	setExcludedViewNames(String[] excludedViewNames)
void	setOrder(int order) Specify the order in which this view resolver will be queried.
void	setRedirectViewProvider(Function<String,org.springframework.web.reactive.result.view.RedirectView> redirectViewProvider) Sets the provider function for creating RedirectView instances when a redirect request is passed to the view resolver.
void	setResponseMaxChunkSizeBytes(int responseMaxChunkSizeBytes) Set the maximum size (in bytes) allowed for the chunks (DataBuffer) that are produced by the Thymeleaf engine and passed to the server as output.
void	setStaticVariables(Map<String,?> variables) Sets a set of static variables, which will be available at the context every time a view resolved by this ViewResolver is processed.
void	setTemplateEngine(ISpringWebFluxTemplateEngine templateEngine) Set the template engine object (implementation of ISpringWebFluxTemplateEngine to be used for processing templates.
void	setViewClass(Class<? extends ThymeleafReactiveView> viewClass) Set the view class that should be used to create views.
void	setViewNames(String[] viewNames)

Methods inherited from class org.springframework.web.reactive.result.view.ViewResolverSupport

getApplicationContext, getDefaultCharset, getSupportedMediaTypes, setApplicationContext, setDefaultCharset, setSupportedMediaTypes

Methods inherited from class Object

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

Field Detail

REDIRECT_URL_PREFIX

public static final String REDIRECT_URL_PREFIX

Prefix to be used in view names (returned by controllers) for specifying an HTTP redirect.

Value: redirect:

See Also:

Constant Field Values

FORWARD_URL_PREFIX

public static final String FORWARD_URL_PREFIX

See Also:

Constant Field Values

Constructor Detail

ThymeleafReactiveViewResolver

public ThymeleafReactiveViewResolver()

Create an instance of ThymeleafReactiveViewResolver.

Method Detail

setViewClass

public void setViewClass(Class<? extends ThymeleafReactiveView> viewClass)

Set the view class that should be used to create views. This must be a subclass of ThymeleafReactiveView.

Parameters:

viewClass - class that is assignable to the required view class (by default, ThymeleafReactiveView).

getViewClass

protected Class<? extends ThymeleafReactiveView> getViewClass()

getTemplateEngine

public ISpringWebFluxTemplateEngine getTemplateEngine()

Returns the Thymeleaf template engine instance (implementation of ISpringWebFluxTemplateEngine to be used for the execution of templates.

Returns:

the template engine being used for processing templates.

setTemplateEngine

public void setTemplateEngine(ISpringWebFluxTemplateEngine templateEngine)

Set the template engine object (implementation of ISpringWebFluxTemplateEngine to be used for processing templates.

Parameters:

templateEngine - the template engine.

getStaticVariables

public Map<String,Object> getStaticVariables()

Return the static variables, which will be available at the context every time a view resolved by this ViewResolver is processed.

These static variables are added to the context by the view resolver before every view is processed, so that they can be referenced from the context like any other context variables, for example: ${myStaticVar}.

Returns:

the map of static variables to be set into views' execution.

addStaticVariable

public void addStaticVariable(String name,
                              Object value)

Add a new static variable.

These static variables are added to the context by the view resolver before every view is processed, so that they can be referenced from the context like any other context variables, for example: ${myStaticVar}.

Parameters:

name - the name of the static variable

value - the value of the static variable

setStaticVariables

public void setStaticVariables(Map<String,?> variables)

Sets a set of static variables, which will be available at the context every time a view resolved by this ViewResolver is processed.

This method does not overwrite the existing static variables, it simply adds the ones specify to any variables already registered.

These static variables are added to the context by the view resolver before every view is processed, so that they can be referenced from the context like any other context variables, for example: ${myStaticVar}.

Parameters:

variables - the set of variables to be added.

setOrder

public void setOrder(int order)

Specify the order in which this view resolver will be queried.

Spring Web applications can have several view resolvers configured, and this order property established the order in which they will be queried for view resolution.

Overrides:

setOrder in class org.springframework.web.reactive.result.view.ViewResolverSupport

Parameters:

order - the order in which this view resolver will be asked to resolve the view.

getOrder

public int getOrder()

Returns the order in which this view resolver will be queried.

Spring Web applications can have several view resolvers configured, and this order property established the order in which they will be queried for view resolution.

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class org.springframework.web.reactive.result.view.ViewResolverSupport

Returns:

the order

setRedirectViewProvider

public void setRedirectViewProvider(Function<String,org.springframework.web.reactive.result.view.RedirectView> redirectViewProvider)

Sets the provider function for creating RedirectView instances when a redirect request is passed to the view resolver.

Note the parameter specified to the function will be the URL of the redirect (as specified in the view name returned by the controller, without the redirect: prefix).

Parameters:

redirectViewProvider - the redirect-view provider function.

getRedirectViewProvider

public Function<String,org.springframework.web.reactive.result.view.RedirectView> getRedirectViewProvider()

Returns the provider function for creating RedirectView instances when a redirect request is passed to the view resolver.

Note the parameter specified to the function will be the URL of the redirect (as specified in the view name returned by the controller, without the redirect: prefix).

Returns:

the redirect-view provider function.

setAlwaysProcessRedirectAndForward

public void setAlwaysProcessRedirectAndForward(boolean alwaysProcessRedirectAndForward)

Set whether this view resolver should always process forwards and redirects independently of the value of the viewNames property.

When this flag is set to true (default value), any view name that starts with the redirect: or forward: prefixes will be resolved by this ViewResolver even if the view names would not match what is established at the viewNames property.

Note that the behaviour of resolving view names with these prefixes is exactly the same with this flag set to true or false (perform an HTTP redirect or forward to an internal resource). The only difference is whether the prefixes have to be explicitly specified at viewNames or not.

Default value is true.

Parameters:

alwaysProcessRedirectAndForward - true if redirects and forwards are always processed, false if this will depend on what is established at the viewNames property.

getAlwaysProcessRedirectAndForward

public boolean getAlwaysProcessRedirectAndForward()

Return whether this view resolver should always process forwards and redirects independently of the value of the viewNames property.

When this flag is set to true (default value), any view name that starts with the redirect: or forward: prefixes will be resolved by this ViewResolver even if the view names would not match what is established at the viewNames property.

Note that the behaviour of resolving view names with these prefixes is exactly the same with this flag set to true or false (perform an HTTP redirect or forward to an internal resource). The only difference is whether the prefixes have to be explicitly specified at viewNames or not.

Default value is true.

Returns:

whether redirects and forwards will be always processed by this view resolver or else only when they are matched by the viewNames property.

setResponseMaxChunkSizeBytes

public void setResponseMaxChunkSizeBytes(int responseMaxChunkSizeBytes)

Set the maximum size (in bytes) allowed for the chunks (DataBuffer) that are produced by the Thymeleaf engine and passed to the server as output.

In Spring WebFlux applications, Thymeleaf has three modes of operation depending on whether a limit has been set for the output chunk size and/or data-driver context variables have been specified:

• FULL, when no limit for max chunk size is established and no data-driver context variable has been specified. All template output will be generated in memory and then sent to the server's output channels as a single DataBuffer.
• CHUNKED, when a limit for max chunk size is established but no data-driver context variable has been specified. Template output will be generated in chunks of a size equal or less than the specified limit (in bytes) and then sent to the server's output channels. After each chunk is sent to output, the template engine will stop (thanks to its throttling mechanism), and wait for the server to request more chunks by means of reactive backpressure. Note all of this mechanism works single-threaded. This execution mode will also force the server to perform output flush operations after each chunk is sent from Thymeleaf.
• DATA-DRIVEN, when a data-driver variable has been specified at the context (implementing IReactiveDataDriverContextVariable). This variable is expected to contain a data stream (usually in the shape of a Publisher that Thymeleaf will consume, creating markup output as data is streamed from this data-driver and letting the output channels of the server throttle template engine execution by means of back-pressure. Additionally, depending on whether a value has been specified for this property or not, Thymeleaf will never generate DataBuffer output chunks larger than the specified size, and will request the server to perform an output flush operation after each chunk is produced.

If this property is set to -1 or Integer.MAX_VALUE, no size limit will be used. Note also that there is no limit set by default.

Also note that this parameter will be ignored when returning SSE (Server-Sent Events), as buffer size in such case will adapt to the size of each returned element (plus its SSE metadata).

Parameters:

responseMaxChunkSizeBytes - the maximum size in bytes for output chunks (DataBuffer objects), or -1 or Integer.MAX_VALUE if no limit is to be used.

getResponseMaxChunkSizeBytes

public int getResponseMaxChunkSizeBytes()

Return the maximum size (in bytes) allowed for the chunks (DataBuffer) that are produced by the Thymeleaf engine and passed to the server as output.

In Spring WebFlux applications, Thymeleaf has three modes of operation depending on whether a limit has been set for the output chunk size and/or data-driver context variables have been specified:

• FULL, when no limit for max chunk size is established and no data-driver context variable has been specified. All template output will be generated in memory and then sent to the server's output channels as a single DataBuffer.
• CHUNKED, when a limit for max chunk size is established but no data-driver context variable has been specified. Template output will be generated in chunks of a size equal or less than the specified limit (in bytes) and then sent to the server's output channels. After each chunk is sent to output, the template engine will stop (thanks to its throttling mechanism), and wait for the server to request more chunks by means of reactive backpressure. Note all of this mechanism works single-threaded. This execution mode will also force the server to perform output flush operations after each chunk is sent from Thymeleaf.
• DATA-DRIVEN, when a data-driver variable has been specified at the context (implementing IReactiveDataDriverContextVariable). This variable is expected to contain a data stream (usually in the shape of a Publisher that Thymeleaf will consume, creating markup output as data is streamed from this data-driver and letting the output channels of the server throttle template engine execution by means of back-pressure. Additionally, depending on whether a value has been specified for this property or not, Thymeleaf will never generate DataBuffer output chunks larger than the specified size, and will request the server to perform an output flush operation after each chunk is produced.

If this property is set to -1 or Integer.MAX_VALUE, no size limit will be used. Note also that there is no limit set by default.

Also note that this parameter will be ignored when returning SSE (Server-Sent Events), as buffer size in such case will adapt to the size of each returned element (plus its SSE metadata).

Returns:

the maximum size in bytes for output chunks (DataBuffer objects), or -1 or Integer.MAX_VALUE if no limit is to be used.

setViewNames

public void setViewNames(String[] viewNames)

getViewNames

public String[] getViewNames()

setExcludedViewNames

public void setExcludedViewNames(String[] excludedViewNames)

getExcludedViewNames

public String[] getExcludedViewNames()

canHandle

protected boolean canHandle(String viewName,
                            Locale locale)

resolveViewName

public reactor.core.publisher.Mono<org.springframework.web.reactive.result.view.View> resolveViewName(String viewName,
                                                                                                      Locale locale)

Specified by:

resolveViewName in interface org.springframework.web.reactive.result.view.ViewResolver

loadView

protected reactor.core.publisher.Mono<org.springframework.web.reactive.result.view.View> loadView(String viewName,
                                                                                                  Locale locale)