Java Doc for ServletToolboxManager.java in  » Template-Engine » Velocity » org » apache » velocity » tools » view » servlet » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 ServletToolboxManager.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.

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 ServletToolboxManager.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.

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)>
 

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 ServletToolboxManager.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.

Sets an application attribute to tell velocimacros and tools (especially the LinkTool) whether they should output XHTML or HTML.