org.apache.velocity.tools.view.servlet
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>
Modifier and Type | Field and Description |
---|---|
private boolean |
exactPath
Deprecated.
|
private java.lang.String |
path
Deprecated.
|
private java.lang.String |
scope
Deprecated.
|
LOG
Constructor and Description |
---|
ServletToolInfo()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
boolean |
allowsRequestPath(java.lang.String requestedPath)
Deprecated.
|
java.lang.String |
getRequestPath()
Deprecated.
|
java.lang.String |
getScope()
Deprecated.
|
void |
setRequestPath(java.lang.String path)
Deprecated.
|
void |
setScope(java.lang.String scope)
Deprecated.
|
getApplicationClass, getClassname, getInstance, getKey, getParameters, setClassname, setKey, setParameter, setParameters
private java.lang.String scope
private boolean exactPath
private java.lang.String path
public void setScope(java.lang.String scope)
public java.lang.String getScope()
public void setRequestPath(java.lang.String path)
path
- the full or partial request path restriction of the toolpublic java.lang.String getRequestPath()
public boolean allowsRequestPath(java.lang.String requestedPath)
requestedPath
- the path of the current servlet requesttrue
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
.Copyright (c) 2003-2007 Apache Software Foundation