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

java.lang.Object
  extended by org.apache.velocity.tools.view.XMLToolboxManager
      extended by org.apache.velocity.tools.view.servlet.ServletToolboxManager
All Implemented Interfaces:
ToolboxManager

public class ServletToolboxManager
extends XMLToolboxManager

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:

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.

Version:
$Id: ServletToolboxManager.java 523762 2007-03-29 16:37:59Z nbubna $
Author:
Gabriel Sidler, Nathan Bubna, Geir Magnusson Jr., Henning P. Schmiedehausen

Field Summary
private  java.util.Map appTools
           
private  boolean createSession
           
protected static org.apache.commons.logging.Log LOG
           
private static java.util.HashMap managersMap
           
private  java.util.ArrayList requestToolInfo
           
private  javax.servlet.ServletContext servletContext
           
private static org.apache.commons.digester.RuleSet servletRuleSet
           
static java.lang.String SESSION_TOOLS_KEY
           
private  java.util.ArrayList sessionToolInfo
           
 
Constructor Summary
protected ServletToolboxManager(javax.servlet.ServletContext servletContext)
          Use getInstance(ServletContext,String) instead to ensure there is exactly one ServletToolboxManager per xml toolbox configuration file.
 
Method Summary
 void addData(ToolInfo info)
          Overrides XMLToolboxManager to put data into appTools map
 void addTool(ToolInfo info)
          Overrides XMLToolboxManager to separate tools by scope.
static ServletToolboxManager getInstance(javax.servlet.ServletContext servletContext, java.lang.String toolboxFile)
          ServletToolboxManager factory method.
protected  java.lang.Object getMutex(javax.servlet.http.HttpSession session)
          Returns a mutex (lock object) unique to the specified session to allow for reliable synchronization on the session.
protected  org.apache.commons.digester.RuleSet getRuleSet()
          Retrieves the rule set Digester should use to parse and load the toolbox for this manager.
 java.util.Map getToolbox(java.lang.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 setXhtml(java.lang.Boolean value)
          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.
 
Methods inherited from class org.apache.velocity.tools.view.XMLToolboxManager
load, load
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SESSION_TOOLS_KEY

public static final java.lang.String SESSION_TOOLS_KEY

LOG

protected static final org.apache.commons.logging.Log LOG

servletContext

private javax.servlet.ServletContext servletContext

appTools

private java.util.Map appTools

sessionToolInfo

private java.util.ArrayList sessionToolInfo

requestToolInfo

private java.util.ArrayList requestToolInfo

createSession

private boolean createSession

managersMap

private static java.util.HashMap managersMap

servletRuleSet

private static org.apache.commons.digester.RuleSet servletRuleSet
Constructor Detail

ServletToolboxManager

protected ServletToolboxManager(javax.servlet.ServletContext servletContext)
Use getInstance(ServletContext,String) instead to ensure there is exactly one ServletToolboxManager per xml toolbox configuration file.

Method Detail

getInstance

public static ServletToolboxManager getInstance(javax.servlet.ServletContext servletContext,
                                                java.lang.String toolboxFile)
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

public void setXhtml(java.lang.Boolean value)

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

Since:
VelocityTools 1.1
See Also:
ViewContext.XHTML

getRuleSet

protected org.apache.commons.digester.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)>
 

Overrides:
getRuleSet in class XMLToolboxManager
Since:
VelocityTools 1.1

validateToolInfo

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.

Overrides:
validateToolInfo in class XMLToolboxManager
Parameters:
info - a ToolInfo object
Returns:
true if the ToolInfo is valid
Since:
VelocityTools 1.3

addTool

public void addTool(ToolInfo info)
Overrides XMLToolboxManager to separate tools by scope. For this to work, we obviously override getToolbox(Object) as well.

Specified by:
addTool in interface ToolboxManager
Overrides:
addTool in class XMLToolboxManager

addData

public void addData(ToolInfo info)
Overrides XMLToolboxManager to put data into appTools map

Specified by:
addData in interface ToolboxManager
Overrides:
addData in class XMLToolboxManager
Parameters:
info - An object that implements ToolInfo

getToolbox

public java.util.Map getToolbox(java.lang.Object initData)
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.

Specified by:
getToolbox in interface ToolboxManager
Overrides:
getToolbox in class XMLToolboxManager
Parameters:
initData - the ViewContext for the current servlet request
Returns:
the created ToolboxContext

getMutex

protected java.lang.Object getMutex(javax.servlet.http.HttpSession session)
Returns a mutex (lock object) unique to the specified session to allow for reliable synchronization on the session.



Copyright (c) 2003-2007 Apache Software Foundation