org.apache.velocity.tools.view.servlet
Class ServletToolInfo

java.lang.Object
  extended by org.apache.velocity.tools.view.ViewToolInfo
      extended by org.apache.velocity.tools.view.servlet.ServletToolInfo
All Implemented Interfaces:
ToolInfo

Deprecated. Use ToolInfo

@Deprecated
public class ServletToolInfo
extends ViewToolInfo

ToolInfo implementation that holds scope information for tools used in a servlet environment. The ServletToolboxManager uses this to allow tool definitions to specify the scope/lifecycle of individual view tools.

Example of toolbox.xml definitions for servlet tools:

  <tool>
    <key>link</key>
    <scope>request</scope>
    <class>org.apache.velocity.tools.struts.StrutsLinkTool</class>
  </tool>
  <tool>
    <key>math</key>
    <scope>application</scope>
    <class>org.apache.velocity.tools.generic.MathTool</class>
  </tool>
  <tool>
    <key>user</key>
    <scope>session</scope>
    <class>com.mycompany.tools.MyUserTool</class>
  </tool>
  

Version:
$Id: ServletToolInfo.java 564438 2007-08-10 00:15:18Z nbubna $
Author:
Nathan Bubna

Field Summary
 
Fields inherited from class org.apache.velocity.tools.view.ViewToolInfo
LOG
 
Constructor Summary
ServletToolInfo()
          Deprecated.  
 
Method Summary
 boolean allowsRequestPath(String requestedPath)
          Deprecated.  
 String getRequestPath()
          Deprecated.  
 String getScope()
          Deprecated.  
 void setRequestPath(String path)
          Deprecated.  
 void setScope(String scope)
          Deprecated.  
 
Methods inherited from class org.apache.velocity.tools.view.ViewToolInfo
getApplicationClass, getClassname, getInstance, getKey, getParameters, setClassname, setKey, setParameter, setParameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServletToolInfo

public ServletToolInfo()
Deprecated. 
Method Detail

setScope

public void setScope(String scope)
Deprecated. 

getScope

public String getScope()
Deprecated. 
Returns:
the scope of the tool

setRequestPath

public void setRequestPath(String path)
Deprecated. 
Parameters:
path - the full or partial request path restriction of the tool
Since:
VelocityTools 1.3

getRequestPath

public String getRequestPath()
Deprecated. 
Returns:
request path restriction for this tool
Since:
VelocityTools 1.3

allowsRequestPath

public boolean allowsRequestPath(String requestedPath)
Deprecated. 
Parameters:
requestedPath - the path of the current servlet request
Returns:
true if the path of the specified request path matches the request path of this tool. If there is no request path restriction for this tool, it will always return true.
Since:
VelocityTools 1.3


Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.