FreeMarkerView

java.lang.Object
- org.springframework.web.reactive.result.view.AbstractView
- - org.springframework.web.reactive.result.view.AbstractUrlBasedView
  - - org.springframework.web.reactive.result.view.freemarker.FreeMarkerView

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware, View
```
public class FreeMarkerView
extends AbstractUrlBasedView
```
A View implementation that uses the FreeMarker template engine.
Depends on a single FreeMarkerConfig object such as FreeMarkerConfigurer being accessible in the application context. Alternatively set the FreeMarker configuration can be set directly on this class via setConfiguration(Configuration).
The url property is the location of the FreeMarker template relative to the FreeMarkerConfigurer's templateLoaderPath.
Note: Spring's FreeMarker support requires FreeMarker 2.3 or higher.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields
Modifier and Type Field and Description

private Configuration configuration

private java.lang.String encoding
- Fields inherited from class org.springframework.web.reactive.result.view.AbstractView
  logger, REQUEST_DATA_VALUE_PROCESSOR_BEAN_NAME

Fields
Modifier and Type	Field and Description
`private Configuration`	`configuration`
`private java.lang.String`	`encoding`

Constructor Summary

Constructors
Constructor and Description

FreeMarkerView()

Constructors
Constructor and Description
`FreeMarkerView()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()` Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
`protected FreeMarkerConfig`	`autodetectConfiguration()` Autodetect a `FreeMarkerConfig` object via the ApplicationContext.
`boolean`	`checkResourceExists(java.util.Locale locale)` Check that the FreeMarker template used for this view exists and is valid.
`private java.util.Optional<java.nio.charset.Charset>`	`getCharset(MediaType mediaType)`
`protected Configuration`	`getConfiguration()` Return the FreeMarker configuration used by this view.
`protected java.lang.String`	`getEncoding()` Return the encoding for the FreeMarker template.
`protected ObjectWrapper`	`getObjectWrapper()` Return the configured FreeMarker `ObjectWrapper`, or the `default wrapper` if none specified.
`protected Template`	`getTemplate(java.util.Locale locale)` Retrieve the FreeMarker template for the given locale, to be rendering by this view.
`protected SimpleHash`	`getTemplateModel(java.util.Map<java.lang.String,java.lang.Object> model, ServerWebExchange exchange)` Build a FreeMarker template model for the given model Map.
`protected <any>`	`renderInternal(java.util.Map<java.lang.String,java.lang.Object> renderAttributes, MediaType contentType, ServerWebExchange exchange)` Subclasses must implement this method to actually render the view.
`void`	`setConfiguration(Configuration configuration)` Set the FreeMarker Configuration to be used by this view.
`void`	`setEncoding(java.lang.String encoding)` Set the encoding of the FreeMarker template file.

Methods inherited from class org.springframework.web.reactive.result.view.AbstractUrlBasedView
getUrl, setUrl, toString

Methods inherited from class org.springframework.web.reactive.result.view.AbstractView
createRequestContext, getApplicationContext, getDefaultCharset, getModelAttributes, getRequestContextAttribute, getRequestDataValueProcessor, getSupportedMediaTypes, render, setApplicationContext, setDefaultCharset, setRequestContextAttribute, setSupportedMediaTypes

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - configuration
```
private Configuration configuration
```
  - encoding
```
private java.lang.String encoding
```
- Constructor Detail
  - FreeMarkerView
```
public FreeMarkerView()
```
- Method Detail
  - setConfiguration
```
public void setConfiguration(Configuration configuration)
```
    Set the FreeMarker Configuration to be used by this view.
    Typically this property is not set directly. Instead a single FreeMarkerConfig is expected in the Spring application context which is used to obtain the FreeMarker configuration.
  - getConfiguration
```
protected Configuration getConfiguration()
```
    Return the FreeMarker configuration used by this view.
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
```
    Set the encoding of the FreeMarker template file.
    By default FreeMarkerConfigurer sets the default encoding in the FreeMarker configuration to "UTF-8". It's recommended to specify the encoding in the FreeMarker Configuration rather than per template if all your templates share a common encoding.
  - getEncoding
```
protected java.lang.String getEncoding()
```
    Return the encoding for the FreeMarker template.
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    Description copied from interface: InitializingBean
    
    Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
    This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
    
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
    
    Overrides:
    
    afterPropertiesSet in class AbstractUrlBasedView
    
    Throws:
    
    java.lang.Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails.
  - autodetectConfiguration
```
protected FreeMarkerConfig autodetectConfiguration()
                                            throws BeansException
```
    Autodetect a FreeMarkerConfig object via the ApplicationContext.
    
    Returns:
    
    the Configuration instance to use for FreeMarkerViews
    
    Throws:
    
    BeansException - if no Configuration instance could be found
    
    See Also:
    
    setConfiguration(Configuration)
  - checkResourceExists
```
public boolean checkResourceExists(java.util.Locale locale)
                            throws java.lang.Exception
```
    Check that the FreeMarker template used for this view exists and is valid.
    Can be overridden to customize the behavior, for example in case of multiple templates to be rendered into a single view.
    
    Specified by:
    
    checkResourceExists in class AbstractUrlBasedView
    
    Parameters:
    
    locale - the desired Locale that we're looking for
    
    Returns:
    
    false if the resource exists false if we know that it does not exist
    
    Throws:
    
    java.lang.Exception - if the resource exists but is invalid (e.g. could not be parsed)
  - renderInternal
```
protected <any> renderInternal(java.util.Map<java.lang.String,java.lang.Object> renderAttributes,
                               MediaType contentType,
                               ServerWebExchange exchange)
```
    Description copied from class: AbstractView
    
    Subclasses must implement this method to actually render the view.
    
    Specified by:
    
    renderInternal in class AbstractView
    
    Parameters:
    
    renderAttributes - combined output Map (never null), with dynamic values taking precedence over static attributes
    
    contentType - the content type selected to render with which should match one of the supported media types.
    
    exchange - current exchange @return Mono to represent when and if rendering succeeds
  - getCharset
```
private java.util.Optional<java.nio.charset.Charset> getCharset(MediaType mediaType)
```
  - getTemplateModel
```
protected SimpleHash getTemplateModel(java.util.Map<java.lang.String,java.lang.Object> model,
                                      ServerWebExchange exchange)
```
    Build a FreeMarker template model for the given model Map.
    The default implementation builds a SimpleHash.
    
    Parameters:
    
    model - the model to use for rendering
    
    exchange - current exchange
    
    Returns:
    
    the FreeMarker template model, as a SimpleHash or subclass thereof
  - getObjectWrapper
```
protected ObjectWrapper getObjectWrapper()
```
    Return the configured FreeMarker ObjectWrapper, or the default wrapper if none specified.
    
    See Also:
    
    freemarker.template.Configuration#getObjectWrapper()
  - getTemplate
```
protected Template getTemplate(java.util.Locale locale)
                        throws java.io.IOException
```
    Retrieve the FreeMarker template for the given locale, to be rendering by this view.
    By default, the template specified by the "url" bean property will be retrieved.
    
    Parameters:
    
    locale - the current locale
    
    Returns:
    
    the FreeMarker template to render
    
    Throws:
    
    java.io.IOException

Class FreeMarkerView

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

configuration

encoding

Constructor Detail

FreeMarkerView

Method Detail

setConfiguration

getConfiguration

setEncoding

getEncoding

afterPropertiesSet

autodetectConfiguration

checkResourceExists

renderInternal

getCharset

getTemplateModel

getObjectWrapper

getTemplate