|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.velocity.tools.view.ViewToolInfo org.apache.velocity.tools.view.servlet.ServletToolInfo
ToolInfo
@Deprecated public class ServletToolInfo
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>
Field Summary | |
---|---|
private boolean |
exactPath
Deprecated. |
private java.lang.String |
path
Deprecated. |
private java.lang.String |
scope
Deprecated. |
Fields inherited from class org.apache.velocity.tools.view.ViewToolInfo |
---|
LOG |
Constructor Summary | |
---|---|
ServletToolInfo()
Deprecated. |
Method Summary | |
---|---|
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. |
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 |
Field Detail |
---|
private java.lang.String scope
private boolean exactPath
private java.lang.String path
Constructor Detail |
---|
public ServletToolInfo()
Method Detail |
---|
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 request
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
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |