Class ServletUtils

java.lang.Object
org.apache.velocity.tools.view.ServletUtils
Direct Known Subclasses:
ServletUtils

public class ServletUtils extends Object

A set of utility methods for supporting and using VelocityTools in the servlet environment.

Version:
$Id: ServletUtils.java 471244 2006-11-04 18:34:38Z henning $
  • Field Details

  • Constructor Details

    • ServletUtils

      protected ServletUtils()
  • Method Details

    • getInstance

      public ServletUtils getInstance()
    • getPath

      public static String getPath(HttpServletRequest request)
      Retrieves the path for the specified request regardless of whether this is a direct request or an include by the RequestDispatcher.
    • getVelocityView

      public static VelocityView getVelocityView(ServletConfig config)
      Returns the shared VelocityView for the specified ServletConfig's context. If one has not yet been created, it will create, store it for future access, and then return it.
    • getVelocityView

      public static VelocityView getVelocityView(FilterConfig config)
      Returns the shared VelocityView for the specified FilterConfig's context. If one has not yet been created, it will create, store it for future access, and then return it.
    • createView

      private static VelocityView createView(JeeConfig config)
    • createView

      private static VelocityView createView(Class klass, JeeConfig config)
    • getVelocityView

      public static VelocityView getVelocityView(ServletContext application)
      Returns the shared VelocityView for the specified ServletContext. If one has not yet been created, it will create one, store it for future access, and then return it.
    • getVelocityView

      public static VelocityView getVelocityView(ServletContext application, boolean createIfMissing)
      Returns the shared VelocityView for the specified ServletContext. If one has not yet been created and the second parameter is true, then it will create one, store it for future access, and return it.
    • findTool

      public static Object findTool(String key, ServletContext application)
    • findTool

      public static Object findTool(String key, String toolboxKey, ServletContext application)
    • findTool

      public static Object findTool(String key, HttpServletRequest request)
    • findTool

      public static Object findTool(String key, String toolboxKey, HttpServletRequest request)
    • findTool

      public static Object findTool(String key, HttpServletRequest request, ServletContext application)
    • findTool

      public static Object findTool(String key, String toolboxKey, HttpServletRequest request, ServletContext application)
    • getInputStream

      public static InputStream getInputStream(String path, ServletContext application)
    • getConfiguration

      public static FactoryConfiguration getConfiguration(ServletContext application)
    • getConfiguration

      public static FactoryConfiguration getConfiguration(String path, ServletContext application)
    • getConfiguration

      public static FactoryConfiguration getConfiguration(String path, ServletContext application, boolean deprecationSupportMode)
    • getMutex

      public static Object getMutex(HttpSession session, String key, Object caller)
      Returns a mutex (lock object) unique to the specified session and stored under the specified key to allow for reliable synchronization on the session.