ThymeleafConfiguration (Cassandra PV Archiver Server 3.2.5 API)

java.lang.Object
- com.aquenos.cassandra.pvarchiver.server.web.common.spring.ThymeleafConfiguration

All Implemented Interfaces:

Aware, ResourceLoaderAware

Direct Known Subclasses:

AdminWebApplication.CustomThymeleafConfiguration
```
@Configuration
public class ThymeleafConfiguration
extends Object
implements ResourceLoaderAware
```
Configuration for using Thymeleaf with Spring Web MVC. This configuration sets up the ThymeleafViewResolver and auxiliary components needed by Thymeleaf.

Author:

Sebastian Marsching

Constructor Summary

Constructors
Constructor and Description

ThymeleafConfiguration()

Constructors
Constructor and Description
`ThymeleafConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`configureDialects(org.thymeleaf.spring4.SpringTemplateEngine templateEngine)` Configures the (non-standard) dialects that are supported by the template engine.
`protected String`	`getTemplateCharacterEncoding()` Returns the character encoding used for template files.
`protected org.thymeleaf.templatemode.TemplateMode`	`getTemplateMode()` Returns the template mode used by Thymeleaf when processing templates.
`protected String`	`getTemplatePrefix()` Returns the prefix prepended to template names in order to find the resource storing the template.
`protected String`	`getTemplateSuffix()` Returns the suffix appended to template names in order to find the resource storing the template.
`protected String`	`getViewCharacterEncoding()` Returns the character encoding used for the output generated by the template engine.
`protected String`	`getViewContentType()` Returns the content type associated with the output generated by the template engine.
`protected boolean`	`isCacheTemplates()` Tells whether templates should be cached.
`void`	`setDevelopmentModeProperties(DevelopmentModeProperties developmentModeProperties)` Sets the development-mode properties used by this configuration.
`void`	`setResourceLoader(ResourceLoader resourceLoader)`
`nz.net.ultraq.thymeleaf.LayoutDialect`	`thymeleafLayoutDialect()` Creates the Thymeleaf layout dialect.
`org.thymeleaf.extras.springsecurity4.dialect.SpringSecurityDialect`	`thymeleafSpringSecurityDialect()` Creates the Thymeleaf Spring Security dialect.
`org.thymeleaf.spring4.SpringTemplateEngine`	`thymeleafTemplateEngine()` Creates the Thymeleaf template engine.
`org.thymeleaf.templateresolver.ITemplateResolver`	`thymeleafTemplateResolver()` Creates the template resolver used by Thymeleaf to resolve template names.
`UriExpanderDialect`	`thymeleafUriExpanderDialect()` Creates the Thymeleaf URI expander dialect.
`org.thymeleaf.spring4.view.ThymeleafViewResolver`	`thymeleafViewResolver()` Creates the Thymeleaf view resolver.

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

- Constructor Detail
  - ThymeleafConfiguration
```
public ThymeleafConfiguration()
```
- Method Detail
  - setDevelopmentModeProperties
```
@Autowired
public void setDevelopmentModeProperties(DevelopmentModeProperties developmentModeProperties)
```
    Sets the development-mode properties used by this configuration. Typically, this method is called by the container.
    
    Parameters:
    
    developmentModeProperties - development-mode properties to be used by this configuration.
  - isCacheTemplates
```
protected boolean isCacheTemplates()
```
    Tells whether templates should be cached. The default implementation decides to cache templates when running in production mode ( DevelopmentModeProperties.isEnabled() returns false ).
    
    Returns:
    
    true if templates should be cached, false if they should be checked for changes on every request.
  - getTemplatePrefix
```
protected String getTemplatePrefix()
```
    Returns the prefix prepended to template names in order to find the resource storing the template. The default implementation returns a prefix of classpath:/META-INF/templates/
    
    Returns:
    
    prefix used for template name resolution.
  - getTemplateSuffix
```
protected String getTemplateSuffix()
```
    Returns the suffix appended to template names in order to find the resource storing the template. The default implementation returns a suffix of .html.
    
    Returns:
    
    suffix used for template name resolution.
  - getTemplateMode
```
protected org.thymeleaf.templatemode.TemplateMode getTemplateMode()
```
    Returns the template mode used by Thymeleaf when processing templates. The template mode determines which kind of output is generated (HTML, XHTML). The default implementation returns HTML5 to produce HTML5 output.
    
    Returns:
    
    template mode to be used by Thymeleaf when processing templates. This must be one of the strings supported by the Thymeleaf template engine.
  - getTemplateCharacterEncoding
```
protected String getTemplateCharacterEncoding()
```
    Returns the character encoding used for template files. The default implementation returns UTF-8.
    
    Returns:
    
    character encoding used for template files.
  - getViewCharacterEncoding
```
protected String getViewCharacterEncoding()
```
    Returns the character encoding used for the output generated by the template engine. The default implementation returns UTF-8. When overriding this method, one should also override getViewContentType().
    
    Returns:
    
    character encoding used for the output generated by the template engine.
  - getViewContentType
```
protected String getViewContentType()
```
    Returns the content type associated with the output generated by the template engine. This is the content type that is typically indicated in the header of an HTTP response. This should include the charset information. The default implementation returns "text/html;charset=UTF-8". When overriding this method, one might also have to override getViewCharacterEncoding().
    
    Returns:
    
    content type of the output generated by the template engine.
  - configureDialects
```
protected void configureDialects(org.thymeleaf.spring4.SpringTemplateEngine templateEngine)
```
    Configures the (non-standard) dialects that are supported by the template engine. This method is called by thymeleafTemplateEngine() after creating the template engine. The default implementation adds the layout dialect, the Spring Security dialect, and the URI expander dialect.
    
    Parameters:
    
    templateEngine - template engine to which dialects can be added.
  - thymeleafTemplateResolver
```
@Bean
public org.thymeleaf.templateresolver.ITemplateResolver thymeleafTemplateResolver()
```
    Creates the template resolver used by Thymeleaf to resolve template names. This template resolver is configured with the parameters returned by getTemplatePrefix(), getTemplateSuffix(), getTemplateMode(), getTemplateCharacterEncoding(), and isCacheTemplates().
    
    Returns:
    
    template resolved used by Thymeleaf.
  - thymeleafTemplateEngine
```
@Bean
public org.thymeleaf.spring4.SpringTemplateEngine thymeleafTemplateEngine()
```
    Creates the Thymeleaf template engine. This is the engine that is used by the thymeleafViewResolver(). The template engine is configured to use the thymeleafTemplateResolver() and subsequently passed on to configureDialects(SpringTemplateEngine).
    
    Returns:
    
    Thymeleaf template engine.
  - thymeleafLayoutDialect
```
@Bean
public nz.net.ultraq.thymeleaf.LayoutDialect thymeleafLayoutDialect()
```
    Creates the Thymeleaf layout dialect. This dialect is added to the template engine by configureDialects(SpringTemplateEngine).
    
    Returns:
    
    Thymeleaf layout dialect.
  - thymeleafSpringSecurityDialect
```
@Bean
public org.thymeleaf.extras.springsecurity4.dialect.SpringSecurityDialect thymeleafSpringSecurityDialect()
```
    Creates the Thymeleaf Spring Security dialect. This dialect is added to the template engine by configureDialects(SpringTemplateEngine).
    
    Returns:
    
    Thymeleaf Spring Security dialect.
  - thymeleafUriExpanderDialect
```
@Bean
public UriExpanderDialect thymeleafUriExpanderDialect()
```
    Creates the Thymeleaf URI expander dialect. This dialect is added to the template engine by configureDialects(SpringTemplateEngine).
    
    Returns:
    
    Thymeleaf URI expander dialect.
  - thymeleafViewResolver
```
@Bean
public org.thymeleaf.spring4.view.ThymeleafViewResolver thymeleafViewResolver()
```
    Creates the Thymeleaf view resolver. This view resolver is configured to use the template engine returned by thymeleafTemplateEngine() and use the character encoding and content type provided by getViewCharacterEncoding() and getViewContentType(). This implementation used a modified version of ThymeleafViewResolver that only handles a view name when the corresponding template file exists. This makes it possible to use the view resolver together with other view resolvers that come later in the chain.
    
    Returns:
    
    view resolver that creates views using the Thymeleaf template engine.
  - setResourceLoader
```
public void setResourceLoader(ResourceLoader resourceLoader)
```
    Specified by:
    
    setResourceLoader in interface ResourceLoaderAware

Class ThymeleafConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThymeleafConfiguration

Method Detail

setDevelopmentModeProperties

isCacheTemplates

getTemplatePrefix

getTemplateSuffix

getTemplateMode

getTemplateCharacterEncoding

getViewCharacterEncoding

getViewContentType

configureDialects

thymeleafTemplateResolver

thymeleafTemplateEngine

thymeleafLayoutDialect

thymeleafSpringSecurityDialect

thymeleafUriExpanderDialect

thymeleafViewResolver

setResourceLoader