Package org.apache.velocity.tools.config

Class ConfigurationUtils

  • public class ConfigurationUtils
extends java.lang.Object
    Utility methods for handling tool configurations.
    Version:
    $Id: ConfigurationUtils.java 511959 2007-02-26 19:24:39Z nbubna $
    Author:
    Nathan Bubna

    • Method Detail

      • getDefaultTools

        public static FactoryConfiguration getDefaultTools()
        Returns the "default" FactoryConfiguration. This includes all the standard tools developed by this project and available in the jar being used. In other words, if the velocity-tools-generic-2.x.jar is being used, then only the generic tools will be included. If the velocity-tools-struts-2.x.jar is being used, then all VelocityTools will be available. This also means that subclasses in the larger jars will override their superclasses. So, if you are using the VelocityStruts jar, then your $link reference will be a StrutsLinkTool. If you are using the VelocityView jar, it will be a standard LinkTool.
        Returns:
        the default FactoryConfiguration

      • findFromSystemProperty

        public static FactoryConfiguration findFromSystemProperty()
        Returns a FactoryConfiguration loaded from the path specified in the "org.apache.velocity.tools" system property (if any). If no such property has been set null will be returned.
        Returns:
        system property defined FactoryConfiguration
        Throws:
        org.apache.velocity.exception.ResourceNotFoundException - if the system property has a value but no configuration file was found at the specified location

      • find

        public static FactoryConfiguration find​(java.lang.String path)
        Searches for a configuration file at the specified path and returns it in the form of a FactoryConfiguration. This method will look for a matching file in both the classpath and the file system. If perchance a match is found in both, then both are loaded and the configuration loaded from the file system is given precedence (i.e. it is added onto the other). If no match is found in either, then this will return null.
        Parameters:
        path - configuration classpath or filesystem path
        Returns:
        new FactoryConfiguration for the given path

      • findInFileSystem

        public static FactoryConfiguration findInFileSystem​(java.lang.String path)
        Searches the file system for a configuration file matching the specified path. If found, it will read and return it as a FactoryConfiguration. If not found, this will return null.
        Parameters:
        path - filesystem path
        Returns:
        new FactoryConfiguration for the given path
        Throws:
        java.lang.IllegalStateException - if the file exists, but its path could not be converted to a URL for reading.

      • findInClasspath

        public static FactoryConfiguration findInClasspath​(java.lang.String path,
                                                   java.lang.Object caller)
        Searches the classpath for a configuration file matching the specified path. If found, it will read and return it as a FactoryConfiguration. If not found, this will return null. If there are multiple matching resources in the classpath, then they will be added together in the order found (i.e. the last one will have precedence).
        Parameters:
        path - configuration classpath
        caller - classloader context
        Returns:
        new FactoryConfiguration for the given classpath
        See Also:
        ClassUtils.getResources(String path, Object caller)

      • read

        public static FactoryConfiguration read​(java.net.URL url)
        Returns a FactoryConfiguration read from a known configuration file type at the specified URL. If the file is missing or unreadable, this will simply return null (i.e. if an IOException is thrown).
        Parameters:
        url - configuration URL
        Returns:
        new FactoryConfiguration for the given URL
        Throws:
        java.lang.UnsupportedOperationException - if the file type (identified via suffix) is neither ".xml" or ".properties"

      • getFromClass

        public static FactoryConfiguration getFromClass​(java.lang.String classname)
        Get a specific FactoryConfiguration class
        Parameters:
        classname - FacotyConfiguration class
        Returns:
        new FactoryConfiguration instance

      • getLog

        public static org.slf4j.Logger getLog​(org.apache.velocity.app.VelocityEngine engine,
                                      java.lang.String childNamespace)