FreeMarkerConfigurer

Class Overview

JavaBean to configure FreeMarker for web usage, via the "configLocation" and/or "freemarkerSettings" and/or "templateLoaderPath" properties. The simplest way to use this class is to specify just a "templateLoaderPath"; you do not need any further configuration then.

 <bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
   <property name="templateLoaderPath"><value>/WEB-INF/freemarker/</value></property>
 </bean>

This bean must be included in the application context of any application using Spring's FreeMarkerView for web MVC. It exists purely to configure FreeMarker. It is not meant to be referenced by application components but just internally by FreeMarkerView. Implements FreeMarkerConfig to be found by FreeMarkerView without depending on the bean name the configurer. Each DispatcherServlet can define its own FreeMarkerConfigurer if desired.

Note that you can also refer to a preconfigured FreeMarker Configuration instance, for example one set up by FreeMarkerConfigurationFactoryBean, via the "configuration" property. This allows to share a FreeMarker Configuration for web and email usage, for example.

This configurer registers a template loader for this package, allowing to reference the "spring.ftl" macro library (contained in this package and thus in spring.jar) like this:

 <#import "spring.ftl" as spring/>
 <@spring.bind "person.age"/>
 age is ${spring.status.value}

Note: Spring's FreeMarker support requires FreeMarker 2.3 or higher.

Summary

[Expand] Inherited Fields
From class org.springframework.ui.freemarker.FreeMarkerConfigurationFactory protected final Log logger

Public Constructors
	FreeMarkerConfigurer()

Public Methods
void	afterPropertiesSet() Initialize FreeMarkerConfigurationFactory's Configuration if not overridden by a preconfigured FreeMarker Configuation.
Configuration	getConfiguration() Return the Configuration object wrapped by this bean.
TaglibFactory	getTaglibFactory() Return the TaglibFactory object wrapped by this bean.
void	setConfiguration(Configuration configuration) Set a preconfigured Configuration to use for the FreeMarker web config, e.g.
void	setServletContext(ServletContext servletContext) Initialize the TaglibFactory for the given ServletContext.

Protected Methods
void	postProcessTemplateLoaders(List<TemplateLoader> templateLoaders) This implementation registers an additional ClassTemplateLoader for the Spring-provided macros, added to the end of the list.

[Expand] Inherited Methods
From class org.springframework.ui.freemarker.FreeMarkerConfigurationFactory Configuration createConfiguration() Prepare the FreeMarker Configuration and return it. TemplateLoader getAggregateTemplateLoader(List<TemplateLoader> templateLoaders) Return a TemplateLoader based on the given TemplateLoader list. ResourceLoader getResourceLoader() Return the Spring ResourceLoader to use for loading FreeMarker template files. TemplateLoader getTemplateLoaderForPath(String templateLoaderPath) Determine a FreeMarker TemplateLoader for the given path. boolean isPreferFileSystemAccess() Return whether to prefer file system access for template loading. Configuration newConfiguration() Return a new Configuration object. void postProcessConfiguration(Configuration config) To be overridden by subclasses that want to to perform custom post-processing of the Configuration object after this factory performed its default initialization. void postProcessTemplateLoaders(List<TemplateLoader> templateLoaders) To be overridden by subclasses that want to to register custom TemplateLoader instances after this factory created its default template loaders. void setConfigLocation(Resource resource) Set the location of the FreeMarker config file. void setDefaultEncoding(String defaultEncoding) Set the default encoding for the FreeMarker configuration. void setFreemarkerSettings(Properties settings) Set properties that contain well-known FreeMarker keys which will be passed to FreeMarker's Configuration.setSettings method. void setFreemarkerVariables(Map<String, Object> variables) Set a Map that contains well-known FreeMarker objects which will be passed to FreeMarker's Configuration.setAllSharedVariables() method. void setPostTemplateLoaders(TemplateLoader[] postTemplateLoaders) Set a List of TemplateLoaders that will be used to search for templates. void setPreTemplateLoaders(TemplateLoader[] preTemplateLoaders) Set a List of TemplateLoaders that will be used to search for templates. void setPreferFileSystemAccess(boolean preferFileSystemAccess) Set whether to prefer file system access for template loading. void setResourceLoader(ResourceLoader resourceLoader) Set the Spring ResourceLoader to use for loading FreeMarker template files. void setTemplateLoaderPath(String templateLoaderPath) Set the Freemarker template loader path via a Spring resource location. void setTemplateLoaderPaths(String[] templateLoaderPaths) Set multiple Freemarker template loader paths via Spring resource locations. void setTemplateLoaders(TemplateLoader[] templateLoaders) This method is deprecated. as of Spring 2.0.1, in favor of the "preTemplateLoaders" and "postTemplateLoaders" properties
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.factory.InitializingBean abstract void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
From interface org.springframework.context.ResourceLoaderAware abstract void setResourceLoader(ResourceLoader resourceLoader) Set the ResourceLoader that this object runs in.
From interface org.springframework.web.context.ServletContextAware abstract void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From interface org.springframework.web.servlet.view.freemarker.FreeMarkerConfig abstract Configuration getConfiguration() Return the FreeMarker Configuration object for the current web application context. abstract TaglibFactory getTaglibFactory() Returns the TaglibFactory used to enable JSP tags to be accessed from FreeMarker templates.