类 ServletUtils

java.lang.Object
org.apache.velocity.tools.view.ServletUtils

public class ServletUtils extends Object

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

版本:
$Id: ServletUtils.java 471244 2006-11-04 18:34:38Z henning $
  • 字段详细资料

    • VELOCITY_VIEW_KEY

      public static final String VELOCITY_VIEW_KEY
    • SHARED_CONFIG_PARAM

      public static final String SHARED_CONFIG_PARAM
      另请参阅:
    • ALT_VELOCITY_VIEW_KEY

      public static final String ALT_VELOCITY_VIEW_KEY
      另请参阅:
    • CONFIGURATION_KEY

      public static final String CONFIGURATION_KEY
      Key used to access a live FactoryConfiguration previously placed in the ServletContext attributes.
      另请参阅:
    • INSTANCE

      public static final ServletUtils INSTANCE
  • 构造器详细资料

    • ServletUtils

      protected ServletUtils()
  • 方法详细资料

    • getInstance

      public ServletUtils getInstance()
    • getPath

      public static String getPath(jakarta.servlet.http.HttpServletRequest request)
      Retrieves the path for the specified request regardless of whether this is a direct request or an include by the RequestDispatcher.
      参数:
      request - servlet request
      返回:
      request path
    • getVelocityView

      public static VelocityView getVelocityView(jakarta.servlet.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.
      参数:
      config - servlet config
      返回:
      VelocityView instance
    • getVelocityView

      public static VelocityView getVelocityView(jakarta.servlet.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.
      参数:
      config - filter config
      返回:
      VelocityView instance
    • getVelocityView

      public static VelocityView getVelocityView(JeeConfig config)
      Returns the shared VelocityView for the specified JeeConfig's context. If one has not yet been created, it will create, store it for future access, and then return it.
      参数:
      config - configuration parameters container (webapp, servlet or filter)
      返回:
      VelocityView instance
    • getVelocityView

      public static VelocityView getVelocityView(jakarta.servlet.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.
      参数:
      application - servlet context
      返回:
      VelocityView instance
    • getVelocityView

      public static VelocityView getVelocityView(jakarta.servlet.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.
      参数:
      application - servlet context
      createIfMissing - whether to create VelocityView if not yet built
      返回:
      VelocityView instance
    • findTool

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

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

      public static Object findTool(String key, jakarta.servlet.http.HttpServletRequest request)
    • findTool

      public static Object findTool(String key, String toolboxKey, jakarta.servlet.http.HttpServletRequest request)
    • findTool

      public static Object findTool(String key, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.ServletContext application)
    • findTool

      public static Object findTool(String key, String toolboxKey, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.ServletContext application)
    • isWebappResource

      protected static boolean isWebappResource(String path)
    • getInputStream

      public static InputStream getInputStream(String path, jakarta.servlet.ServletContext application)
    • getURL

      public static URL getURL(String path, jakarta.servlet.ServletContext application)
    • getConfiguration

      public static FactoryConfiguration getConfiguration(jakarta.servlet.ServletContext application)
    • getConfiguration

      public static FactoryConfiguration getConfiguration(String path, jakarta.servlet.ServletContext application)
    • getMutex

      public static Object getMutex(jakarta.servlet.http.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.
      参数:
      session - HTTP session
      key - mutex key
      caller - caller object
      返回:
      session mutex object
    • combinePath

      public static String combinePath(String before, String after)
      If end is null, this will return start and vice versa. If neither is null, this will append the end to the start, making sure that there is only one '/' character between the two values.
      参数:
      before - start path
      after - end path
      返回:
      combined path