public class

FreeMarkerConfigurationFactoryBean

extends FreeMarkerConfigurationFactory
implements FactoryBean<T> InitializingBean ResourceLoaderAware
java.lang.Object
   ↳ org.springframework.ui.freemarker.FreeMarkerConfigurationFactory
     ↳ org.springframework.ui.freemarker.FreeMarkerConfigurationFactoryBean

Class Overview

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.

See Also

Summary

[Expand]
Inherited Fields
From class org.springframework.ui.freemarker.FreeMarkerConfigurationFactory
Public Constructors
FreeMarkerConfigurationFactoryBean()
Public Methods
void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Configuration getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.
Class<? extends Configuration> getObjectType()
Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean 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.

[Expand]
Inherited Methods
From class org.springframework.ui.freemarker.FreeMarkerConfigurationFactory
From class java.lang.Object
From interface org.springframework.beans.factory.FactoryBean
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.context.ResourceLoaderAware

Public Constructors

public FreeMarkerConfigurationFactoryBean ()

Public Methods

public void afterPropertiesSet ()

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.

Throws
IOException
TemplateException

public Configuration 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
  • an instance of the bean (can be null)

public Class<? extends Configuration> 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
  • the type of object that this FactoryBean creates, or null if not known at the time of the call

public boolean 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 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.

Returns
  • whether the exposed object is a singleton