Class FreeMarkerConfigurationFactoryBean
- All Implemented Interfaces:
Aware
,FactoryBean<freemarker.template.Configuration>
,InitializingBean
,ResourceLoaderAware
Configuration
and provides it
as a bean reference.
This bean is intended for any kind of usage of FreeMarker in application
code — for example, 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 FreeMarkerConfigurationFactory
base class for configuration
details.
Note: Spring's FreeMarker support requires FreeMarker 2.3.33 or higher.
- Since:
- 03.03.2004
- Author:
- Darren Davison
- See Also:
-
Field Summary
Fields inherited from class org.springframework.ui.freemarker.FreeMarkerConfigurationFactory
logger
Fields inherited from interface org.springframework.beans.factory.FactoryBean
OBJECT_TYPE_ATTRIBUTE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.freemarker.template.Configuration
Return an instance (possibly shared or independent) of the object managed by this factory.Class<? extends freemarker.template.Configuration>
Return the type of object that this FactoryBean creates, ornull
if not known in advance.boolean
Is the object managed by this factory a singleton? That is, willFactoryBean.getObject()
always return the same object (a reference that can be cached)?Methods inherited from class org.springframework.ui.freemarker.FreeMarkerConfigurationFactory
createConfiguration, getAggregateTemplateLoader, getResourceLoader, getTemplateLoaderForPath, isPreferFileSystemAccess, newConfiguration, postProcessConfiguration, postProcessTemplateLoaders, setConfigLocation, setDefaultCharset, setDefaultEncoding, setFreemarkerSettings, setFreemarkerVariables, setPostTemplateLoaders, setPreferFileSystemAccess, setPreTemplateLoaders, setResourceLoader, setTemplateLoaderPath, setTemplateLoaderPaths
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.context.ResourceLoaderAware
setResourceLoader
-
Constructor Details
-
FreeMarkerConfigurationFactoryBean
public FreeMarkerConfigurationFactoryBean()
-
-
Method Details
-
afterPropertiesSet
Description copied from interface:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,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.
- Specified by:
afterPropertiesSet
in interfaceInitializingBean
- Throws:
IOException
freemarker.template.TemplateException
-
getObject
Description copied from interface:FactoryBean
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.- Specified by:
getObject
in interfaceFactoryBean<freemarker.template.Configuration>
- Returns:
- an instance of the bean (can be
null
) - See Also:
-
getObjectType
Description copied from interface:FactoryBean
Return the type of object that this FactoryBean creates, ornull
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.- Specified by:
getObjectType
in interfaceFactoryBean<freemarker.template.Configuration>
- Returns:
- the type of object that this FactoryBean creates,
or
null
if not known at the time of the call - See Also:
-
isSingleton
public boolean isSingleton()Description copied from interface:FactoryBean
Is the object managed by this factory a singleton? That is, willFactoryBean.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 returntrue
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 extendedSmartFactoryBean
interface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()
method. PlainFactoryBean
implementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()
implementation returnsfalse
.The default implementation returns
true
, since aFactoryBean
typically manages a singleton instance.- Specified by:
isSingleton
in interfaceFactoryBean<freemarker.template.Configuration>
- Returns:
- whether the exposed object is a singleton
- See Also:
-