VelocityEngineFactoryBean (Spring Framework Extension 6.0.0 API)

java.lang.Object
- net.shibboleth.ext.spring.velocity.VelocityEngineFactory
- - net.shibboleth.ext.spring.velocity.VelocityEngineFactoryBean

All Implemented Interfaces:

Aware, FactoryBean<org.apache.velocity.app.VelocityEngine>, InitializingBean, ResourceLoaderAware
```
public class VelocityEngineFactoryBean
extends VelocityEngineFactory
implements FactoryBean<org.apache.velocity.app.VelocityEngine>, InitializingBean, 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="net.shibboleth.ext.spring.velocity.VelocityEngineFactoryBean">
   <property name="resourceLoaderPath" value="/WEB-INF/velocity/"/>
 </bean>
```
See the base class VelocityEngineFactory for configuration details.
Since:

6.0.0

See Also:

VelocityEngineFactory.setConfigLocation(org.springframework.core.io.Resource), VelocityEngineFactory.setVelocityProperties(java.util.Properties), VelocityEngineFactory.setResourceLoaderPath(java.lang.String), VelocityConfigurer

Field Summary

Fields
Modifier and Type Field Description

private org.apache.velocity.app.VelocityEngine velocityEngine
Engine being created.
- Fields inherited from interface org.springframework.beans.factory.FactoryBean
  OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors
Constructor Description

VelocityEngineFactoryBean()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`afterPropertiesSet()`
`org.apache.velocity.app.VelocityEngine`	`getObject()`
`Class<? extends org.apache.velocity.app.VelocityEngine>`	`getObjectType()`
`boolean`	`isSingleton()`

Methods inherited from class net.shibboleth.ext.spring.velocity.VelocityEngineFactory
createVelocityEngine, initSpringResourceLoader, initVelocityResourceLoader, 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

- Field Detail
  - velocityEngine
```
@Nullable
private org.apache.velocity.app.VelocityEngine velocityEngine
```
    Engine being created.
- Constructor Detail
  - VelocityEngineFactoryBean
```
public VelocityEngineFactoryBean()
```
- Method Detail
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws IOException,
                               org.apache.velocity.exception.VelocityException
```
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
    
    Throws:
    
    IOException
    
    org.apache.velocity.exception.VelocityException
  - getObject
```
@Nullable
public org.apache.velocity.app.VelocityEngine getObject()
```
    Specified by:
    
    getObject in interface FactoryBean<org.apache.velocity.app.VelocityEngine>
  - getObjectType
```
@Nullable
public Class<? extends org.apache.velocity.app.VelocityEngine> getObjectType()
```
    Specified by:
    
    getObjectType in interface FactoryBean<org.apache.velocity.app.VelocityEngine>
  - isSingleton
```
public boolean isSingleton()
```
    Specified by:
    
    isSingleton in interface FactoryBean<org.apache.velocity.app.VelocityEngine>