Top Description Fields Constructors Methods
org.springframework.ui.freemarker

public Class FreeMarkerConfigurationFactoryBean

extends FreeMarkerConfigurationFactory
implements org.springframework.beans.factory.FactoryBean<freemarker.template.Configuration>, InitializingBean, ResourceLoaderAware
Class Inheritance
All Implemented Interfaces
org.springframework.context.ResourceLoaderAware, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.FactoryBean
Imports
java.io.IOException, freemarker.template.Configuration, freemarker.template.TemplateException, org.springframework.beans.factory.FactoryBean, .InitializingBean, org.springframework.context.ResourceLoaderAware, org.springframework.lang.Nullable
Factory bean that creates a FreeMarker Configuration and provides it as bean reference. This bean is intended for any kind of usage of FreeMarker in application code, e.g. for generating email content. For web views, FreeMarkerConfigurer is used to set up a FreeMarkerConfigurationFactory.

The simplest way to use this class is to specify just a "templateLoaderPath"; you do not need any further configuration then. For example, in a web application context: 

 <bean id="freemarkerConfiguration" class="org.springframework.ui.freemarker.FreeMarkerConfigurationFactoryBean">
  <property name="templateLoaderPath" value="/WEB-INF/freemarker/"/>
</bean>
See the base class FreeMarkerConfigurationFactory for configuration details.

Note

Spring's FreeMarker support requires FreeMarker 2.3 or higher.

Author
Darren Davison
Since
03.03.2004
See Also
setConfigLocation, setFreemarkerSettings, setTemplateLoaderPath, org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer

Field Summary

Modifier and TypeField and Description
private freemarker.template.Configuration
configuration

Inherited from org.springframework.ui.freemarker.FreeMarkerConfigurationFactory:
logger

Constructor Summary

AccessConstructor and Description
public
FreeMarkerConfigurationFactoryBean()

Method Summary

Modifier and TypeMethod and Description
public void
afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

public freemarker.template.Configuration
getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Return an instance (possibly shared or independent) of the object managed by this factory.

public Class<? extends freemarker.template.Configuration>
getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Return the type of object that this FactoryBean creates, or null if not known in advance.

public boolean
isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton?

Inherited from org.springframework.ui.freemarker.FreeMarkerConfigurationFactory:
createConfigurationgetAggregateTemplateLoadergetResourceLoadergetTemplateLoaderForPathisPreferFileSystemAccessnewConfigurationpostProcessConfigurationpostProcessTemplateLoaderssetConfigLocationsetDefaultEncodingsetFreemarkerSettingssetFreemarkerVariablessetPostTemplateLoaderssetPreferFileSystemAccesssetPreTemplateLoaderssetResourceLoadersetTemplateLoaderPathsetTemplateLoaderPaths

Field Detail

configurationback to summary
private freemarker.template.Configuration configuration
Annotations
@Nullable

Constructor Detail

FreeMarkerConfigurationFactoryBeanback to summary
public FreeMarkerConfigurationFactoryBean()

Method Detail

afterPropertiesSetback to summary
public void afterPropertiesSet() throws IOException, freemarker.template.TemplateException

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations
@Override
getObjectback to summary
public freemarker.template.Configuration getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Returns:freemarker.template.Configuration

an instance of the bean (can be null)

Annotations
@Override
@Nullable
getObjectTypeback to summary
public Class<? extends freemarker.template.Configuration> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

Note

Autowiring will simply ignore FactoryBeans that return null here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Returns:Class<? extends freemarker.template.Configuration>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations
@Override
isSingletonback to summary
public boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

Note

If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

Note

This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean#isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

The default implementation returns true, since a FactoryBean typically manages a singleton instance.

Returns:boolean

whether the exposed object is a singleton

Annotations
@Override