Package org.springframework.ui.velocity

Class VelocityEngineFactory

    • Field Detail

    • Method Detail

      • setResourceLoaderPath

        public void setResourceLoaderPath​(String resourceLoaderPath)
        Deprecated.
        Set the Velocity resource loader path via a Spring resource location. Accepts multiple locations in Velocity's comma-separated path style.

        When populated via a String, standard URLs like "file:" and "classpath:" pseudo URLs are supported, as understood by ResourceLoader. Allows for relative paths when running in an ApplicationContext.

        Will define a path for the default Velocity resource loader with the name "file". If the specified resource cannot be resolved to a java.io.File, a generic SpringResourceLoader will be used under the name "spring", without modification detection.

        Note that resource caching will be enabled in any case. With the file resource loader, the last-modified timestamp will be checked on access to detect changes. With SpringResourceLoader, the resource will be cached forever (for example for class path resources).

        To specify a modification check interval for files, use Velocity's standard "file.resource.loader.modificationCheckInterval" property. By default, the file timestamp is checked on every access (which is surprisingly fast). Of course, this just applies when loading resources from the file system.

        To enforce the use of SpringResourceLoader, i.e. to not resolve a path as file system resource in any case, turn off the "preferFileSystemAccess" flag. See the latter's javadoc for details.

        See Also:
        setResourceLoader(org.springframework.core.io.ResourceLoader), setVelocityProperties(java.util.Properties), setPreferFileSystemAccess(boolean), SpringResourceLoader, FileResourceLoader

      • setPreferFileSystemAccess

        public void setPreferFileSystemAccess​(boolean preferFileSystemAccess)
        Deprecated.
        Set whether to prefer file system access for template loading. File system access enables hot detection of template changes.

        If this is enabled, VelocityEngineFactory will try to resolve the specified "resourceLoaderPath" as file system resource (which will work for expanded class path resources and ServletContext resources too).

        Default is "true". Turn this off to always load via SpringResourceLoader (i.e. as stream, without hot detection of template changes), which might be necessary if some of your templates reside in an expanded classes directory while others reside in jar files.

        See Also:
        setResourceLoaderPath(java.lang.String)

      • isPreferFileSystemAccess

        protected boolean isPreferFileSystemAccess()
        Deprecated.
        Return whether to prefer file system access for template loading.

      • setOverrideLogging

        public void setOverrideLogging​(boolean overrideLogging)
        Deprecated.
        Set whether Velocity should log via Commons Logging, i.e. whether Velocity's log system should be set to CommonsLogLogChute. Default is "true".

      • createVelocityEngine

        public org.apache.velocity.app.VelocityEngine createVelocityEngine()
                                                            throws IOException,
                                                                   org.apache.velocity.exception.VelocityException
        Deprecated.
        Prepare the VelocityEngine instance and return it.
        Returns:
        the VelocityEngine instance
        Throws:
        IOException - if the config file wasn't found
        org.apache.velocity.exception.VelocityException - on Velocity initialization failure

      • newVelocityEngine

        protected org.apache.velocity.app.VelocityEngine newVelocityEngine()
                                                            throws IOException,
                                                                   org.apache.velocity.exception.VelocityException
        Deprecated.
        Return a new VelocityEngine. Subclasses can override this for custom initialization, or for using a mock object for testing.

        Called by createVelocityEngine().

        Returns:
        the VelocityEngine instance
        Throws:
        IOException - if a config file wasn't found
        org.apache.velocity.exception.VelocityException - on Velocity initialization failure
        See Also:
        createVelocityEngine()

      • postProcessVelocityEngine

        protected void postProcessVelocityEngine​(org.apache.velocity.app.VelocityEngine velocityEngine)
                                  throws IOException,
                                         org.apache.velocity.exception.VelocityException
        Deprecated.
        To be implemented by subclasses that want to perform custom post-processing of the VelocityEngine after this FactoryBean performed its default configuration (but before VelocityEngine.init).

        Called by createVelocityEngine().

        Parameters:
        velocityEngine - the current VelocityEngine
        Throws:
        IOException - if a config file wasn't found
        org.apache.velocity.exception.VelocityException - on Velocity initialization failure
        See Also:
        createVelocityEngine(), VelocityEngine.init()