public class VelocityConfigurer extends VelocityEngineFactory implements VelocityConfig, InitializingBean, ResourceLoaderAware, ServletContextAware
<bean id="velocityConfig" class="org.springframework.web.servlet.view.velocity.VelocityConfigurer"> <property name="resourceLoaderPath"><value>/WEB-INF/velocity/</value></property> </bean>This bean must be included in the application context of any application using Spring's
VelocityView
for web MVC. It exists purely to configure
Velocity; it is not meant to be referenced by application components (just
internally by VelocityView). This class implements VelocityConfig
in order to be found by VelocityView without depending on the bean name of
this configurer. Each DispatcherServlet may define its own VelocityConfigurer
if desired, potentially with different template loader paths.
Note that you can also refer to a pre-configured VelocityEngine
instance via the "velocityEngine" property, e.g. set up by
VelocityEngineFactoryBean
,
This allows to share a VelocityEngine for web and email usage, for example.
This configurer registers the "spring.vm" Velocimacro library for web views
(contained in this package and thus in spring.jar
), which makes
all of Spring's default Velocity macros available to the views.
This allows for using the Spring-provided macros such as follows:
#springBind("person.age") age is ${status.value}
VelocityEngineFactory.setConfigLocation(org.springframework.core.io.Resource)
,
VelocityEngineFactory.setVelocityProperties(java.util.Properties)
,
VelocityEngineFactory.setResourceLoaderPath(java.lang.String)
,
setVelocityEngine(org.apache.velocity.app.VelocityEngine)
,
VelocityView
logger
Constructor and Description |
---|
VelocityConfigurer() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Initialize VelocityEngineFactory's VelocityEngine
if not overridden by a pre-configured VelocityEngine.
|
org.apache.velocity.app.VelocityEngine |
getVelocityEngine()
Return the VelocityEngine for the current web application context.
|
protected void |
postProcessVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)
Provides a ClasspathResourceLoader in addition to any default or user-defined
loader in order to load the spring Velocity macros from the class path.
|
void |
setServletContext(ServletContext servletContext)
Set the
ServletContext that this object runs in. |
void |
setVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)
Set a pre-configured VelocityEngine to use for the Velocity web
configuration: e.g.
|
createVelocityEngine, getResourceLoader, initSpringResourceLoader, initVelocityResourceLoader, isPreferFileSystemAccess, newVelocityEngine, setConfigLocation, setOverrideLogging, setPreferFileSystemAccess, setResourceLoader, setResourceLoaderPath, setVelocityProperties, setVelocityPropertiesMap
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setResourceLoader
public void setVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)
VelocityEngineFactoryBean
.
Note that the Spring macros will not be enabled automatically in
case of an external VelocityEngine passed in here. Make sure to include
spring.vm
in your template loader path in such a scenario
(if there is an actual need to use those macros).
If this is not set, VelocityEngineFactory's properties (inherited by this class) have to be specified.
public void setServletContext(ServletContext servletContext)
ServletContextAware
ServletContext
that this object runs in.
Invoked after population of normal bean properties but before an init
callback like InitializingBean's afterPropertiesSet
or a
custom init-method. Invoked after ApplicationContextAware's
setApplicationContext
.
setServletContext
in interface ServletContextAware
servletContext
- ServletContext object to be used by this objectInitializingBean.afterPropertiesSet()
,
ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
public void afterPropertiesSet() throws IOException, org.apache.velocity.exception.VelocityException
afterPropertiesSet
in interface InitializingBean
IOException
org.apache.velocity.exception.VelocityException
VelocityEngineFactory.createVelocityEngine()
,
setVelocityEngine(org.apache.velocity.app.VelocityEngine)
protected void postProcessVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)
postProcessVelocityEngine
in class VelocityEngineFactory
velocityEngine
- the current VelocityEngineClasspathResourceLoader
public org.apache.velocity.app.VelocityEngine getVelocityEngine()
VelocityConfig
getVelocityEngine
in interface VelocityConfig