Package org.apache.velocity.spring
Class VelocityEngineFactoryBean
java.lang.Object
org.apache.velocity.spring.VelocityEngineFactory
org.apache.velocity.spring.VelocityEngineFactoryBean
- All Implemented Interfaces:
org.springframework.beans.factory.Aware
,org.springframework.beans.factory.FactoryBean<VelocityEngine>
,org.springframework.beans.factory.InitializingBean
,org.springframework.context.ResourceLoaderAware
public class VelocityEngineFactoryBean
extends VelocityEngineFactory
implements org.springframework.beans.factory.FactoryBean<VelocityEngine>, org.springframework.beans.factory.InitializingBean, org.springframework.context.ResourceLoaderAware
Factory bean that configures a VelocityEngine and provides it as bean
reference. This bean is intended for any kind of usage of Velocity in
application code, e.g. for generating email content. For web views,
VelocityConfigurer is used to set up a VelocityEngine for views.
The simplest way to use this class is to specify a "resourceLoaderPath"; you do not need any further configuration then. For example, in a web application context:
<bean id="velocityEngine" class="org.springframework.ui.velocity.VelocityEngineFactoryBean"> <property name="resourceLoaderPath" value="/WEB-INF/velocity/"/> </bean>See the base class VelocityEngineFactory for configuration details.
- Since:
- 2020-05-29
- Author:
- Juergen Hoeller, Claude Brisson
- See Also:
-
Field Summary
Fields inherited from class org.apache.velocity.spring.VelocityEngineFactory
logger
Fields inherited from interface org.springframework.beans.factory.FactoryBean
OBJECT_TYPE_ATTRIBUTE
-
Constructor Summary
-
Method Summary
Methods inherited from class org.apache.velocity.spring.VelocityEngineFactory
createVelocityEngine, getResourceLoader, initSpringResourceLoader, initVelocityResourceLoader, isPreferFileSystemAccess, newVelocityEngine, postProcessVelocityEngine, setConfigLocation, setPreferFileSystemAccess, setResourceLoader, setResourceLoaderPath, setVelocityProperties, setVelocityPropertiesMap
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
-
VelocityEngineFactoryBean
public VelocityEngineFactoryBean()
-
-
Method Details
-
afterPropertiesSet
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
IOException
VelocityException
-
getObject
- Specified by:
getObject
in interfaceorg.springframework.beans.factory.FactoryBean<VelocityEngine>
-
getObjectType
- Specified by:
getObjectType
in interfaceorg.springframework.beans.factory.FactoryBean<VelocityEngine>
-
isSingleton
public boolean isSingleton()- Specified by:
isSingleton
in interfaceorg.springframework.beans.factory.FactoryBean<VelocityEngine>
-