java.lang.Object
   ↳ org.springframework.ui.velocity.VelocityEngineFactory
     ↳ org.springframework.web.servlet.view.velocity.VelocityConfigurer

Class Overview

JavaBean to configure Velocity for web usage, via the "configLocation" and/or "velocityProperties" and/or "resourceLoaderPath" bean properties. The simplest way to use this class is to specify just a "resourceLoaderPath"; you do not need any further configuration then. 

 <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}

See Also

Summary

[Expand]
Inherited Fields
From class org.springframework.ui.velocity.VelocityEngineFactory
Public Constructors
VelocityConfigurer()
Public Methods
void afterPropertiesSet()
Initialize VelocityEngineFactory's VelocityEngine if not overridden by a pre-configured VelocityEngine.
VelocityEngine getVelocityEngine()
Return the VelocityEngine for the current web application context.
void setServletContext(ServletContext servletContext)
Set the ServletContext that this object runs in.
void setVelocityEngine(VelocityEngine velocityEngine)
Set a pre-configured VelocityEngine to use for the Velocity web configuration: e.g.
Protected Methods
void postProcessVelocityEngine(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.
[Expand]
Inherited Methods
From class org.springframework.ui.velocity.VelocityEngineFactory
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.context.ResourceLoaderAware
From interface org.springframework.web.context.ServletContextAware
From interface org.springframework.web.servlet.view.velocity.VelocityConfig

Public Constructors

public VelocityConfigurer ()

Public Methods

public void afterPropertiesSet ()

Initialize VelocityEngineFactory's VelocityEngine if not overridden by a pre-configured VelocityEngine.

Throws
IOException
VelocityException
See Also

public VelocityEngine getVelocityEngine ()

Return the VelocityEngine for the current web application context. May be unique to one servlet, or shared in the root context.

Returns
  • the VelocityEngine

public void setServletContext (ServletContext servletContext)

Set the 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.

Parameters
servletContext ServletContext object to be used by this object

public void setVelocityEngine (VelocityEngine velocityEngine)

Set a pre-configured VelocityEngine to use for the Velocity web configuration: e.g. a shared one for web and email usage, set up via 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.

Protected Methods

protected void postProcessVelocityEngine (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.

Parameters
velocityEngine the current VelocityEngine
See Also
  • org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader