类 ServletToolboxManager
- 所有已实现的接口:
ToolboxManager
A toolbox manager for the servlet environment.
A toolbox manager is responsible for automatically filling the Velocity context with a set of view tools. This class provides the following features:
- configurable through an XML-based configuration file
- assembles a set of view tools (the toolbox) on request
- handles different tool scopes (request, session, application)
- supports any class with a public constructor without parameters to be used as a view tool
- supports adding primitive data values to the context(String,Number,Boolean)
Configuration
The toolbox manager is configured through an XML-based configuration
file. The configuration file is passed to the XMLToolboxManager.load(java.io.InputStream input)
method. The format is shown in the following example:
<?xml version="1.0"?> <toolbox> <tool> <key>link</key> <scope>request</scope> <class>org.apache.velocity.tools.view.tools.LinkTool</class> </tool> <tool> <key>date</key> <scope>application</scope> <class>org.apache.velocity.tools.generic.DateTool</class> </tool> <data type="number"> <key>luckynumber</key> <value>1.37</value> </data> <data type="string"> <key>greeting</key> <value>Hello World!</value> </data> <xhtml>true</xhtml> </toolbox>
The recommended location for the configuration file is the WEB-INF directory of the web application.
- 版本:
- $Id: ServletToolboxManager.java 651470 2008-04-25 00:47:52Z nbubna $
- 作者:
- Gabriel Sidler, Nathan Bubna, Geir Magnusson Jr., Henning P. Schmiedehausen
-
字段概要
字段 -
构造器概要
构造器限定符构造器说明private
ServletToolboxManager
(ServletContext servletContext) 已过时。Use getInstance(ServletContext,String) instead to ensure there is exactly one ServletToolboxManager per xml toolbox configuration file. -
方法概要
修饰符和类型方法说明void
已过时。Overrides XMLToolboxManager to put data into appTools mapvoid
已过时。Overrides XMLToolboxManager to separate tools by scope.static ServletToolboxManager
getInstance
(ServletContext servletContext, String toolboxFile) 已过时。ServletToolboxManager factory method.protected Object
getMutex
(HttpSession session) 已过时。Returns a mutex (lock object) unique to the specified session to allow for reliable synchronization on the session.protected RuleSet
已过时。Retrieves the rule set Digester should use to parse and load the toolbox for this manager.getToolbox
(Object initData) 已过时。Overrides XMLToolboxManager to handle the separate scopes.void
setCreateSession
(boolean b) 已过时。Sets whether or not to create a new session when none exists for the current request and session-scoped tools have been defined for this toolbox.void
已过时。Sets an application attribute to tell velocimacros and tools (especially the LinkTool) whether they should output XHTML or HTML.protected boolean
validateToolInfo
(ToolInfo info) 已过时。Ensures that application-scoped tools do not have request path restrictions set for them, as those will not be enforced.从类继承的方法 org.apache.velocity.tools.view.XMLToolboxManager
load, load
-
字段详细资料
-
SESSION_TOOLS_KEY
已过时。 -
LOG
protected static final Log LOG已过时。 -
servletContext
private ServletContext servletContext已过时。 -
appTools
已过时。 -
sessionToolInfo
已过时。 -
requestToolInfo
已过时。 -
createSession
private boolean createSession已过时。 -
managersMap
已过时。 -
servletRuleSet
private static RuleSet servletRuleSet已过时。
-
-
构造器详细资料
-
ServletToolboxManager
private ServletToolboxManager(ServletContext servletContext) 已过时。Use getInstance(ServletContext,String) instead to ensure there is exactly one ServletToolboxManager per xml toolbox configuration file.
-
-
方法详细资料
-
getInstance
已过时。ServletToolboxManager factory method. This method will ensure there is exactly one ServletToolboxManager per xml toolbox configuration file. -
setCreateSession
public void setCreateSession(boolean b) 已过时。Sets whether or not to create a new session when none exists for the current request and session-scoped tools have been defined for this toolbox.
If true, then a call to
getToolbox(Object)
will create a new session if none currently exists for this request and the toolbox has one or more session-scoped tools designed.If false, then a call to getToolbox(Object) will never create a new session for the current request. This effectively means that no session-scoped tools will be added to the ToolboxContext for a request that does not have a session object.
The default value is true. -
setXhtml
已过时。Sets an application attribute to tell velocimacros and tools (especially the LinkTool) whether they should output XHTML or HTML.
- 从以下版本开始:
- VelocityTools 1.1
- 另请参阅:
-
getRuleSet
protected RuleSet getRuleSet()已过时。Retrieves the rule set Digester should use to parse and load the toolbox for this manager.
The DTD corresponding to the ServletToolboxRuleSet is:
<?xml version="1.0"?> <!ELEMENT toolbox (create-session?,xhtml?,tool*,data*,#PCDATA)> <!ELEMENT create-session (#CDATA)> <!ELEMENT xhtml (#CDATA)> <!ELEMENT tool (key,scope?,class,parameter*,#PCDATA)> <!ELEMENT data (key,value)> <!ATTLIST data type (string|number|boolean) "string"> <!ELEMENT key (#CDATA)> <!ELEMENT scope (#CDATA)> <!ELEMENT class (#CDATA)> <!ELEMENT parameter (EMPTY)> <!ATTLIST parameter name CDATA #REQUIRED> <!ATTLIST parameter value CDATA #REQUIRED> <!ELEMENT value (#CDATA)>
- 覆盖:
getRuleSet
在类中XMLToolboxManager
- 从以下版本开始:
- VelocityTools 1.1
-
validateToolInfo
已过时。Ensures that application-scoped tools do not have request path restrictions set for them, as those will not be enforced.- 覆盖:
validateToolInfo
在类中XMLToolboxManager
- 参数:
info
- a ToolInfo object- 返回:
- true if the ToolInfo is valid
- 从以下版本开始:
- VelocityTools 1.3
-
addTool
已过时。Overrides XMLToolboxManager to separate tools by scope. For this to work, we obviously override getToolbox(Object) as well.- 指定者:
addTool
在接口中ToolboxManager
- 覆盖:
addTool
在类中XMLToolboxManager
-
addData
已过时。Overrides XMLToolboxManager to put data into appTools map- 指定者:
addData
在接口中ToolboxManager
- 覆盖:
addData
在类中XMLToolboxManager
- 参数:
info
- An object that implements ToolInfo
-
getToolbox
已过时。Overrides XMLToolboxManager to handle the separate scopes. Application scope tools were initialized when the toolbox was loaded. Session scope tools are initialized once per session and stored in a map in the session attributes. Request scope tools are initialized on every request.- 指定者:
getToolbox
在接口中ToolboxManager
- 覆盖:
getToolbox
在类中XMLToolboxManager
- 参数:
initData
- theViewContext
for the current servlet request- 返回:
- the created ToolboxContext
-
getMutex
已过时。Returns a mutex (lock object) unique to the specified session to allow for reliable synchronization on the session.
-
XmlFactoryConfiguration