org.sakaiproject.component.kernel.tool
Class ActiveToolComponent

java.lang.Object
  extended byorg.sakaiproject.component.kernel.tool.ToolComponent
      extended byorg.sakaiproject.component.kernel.tool.ActiveToolComponent
All Implemented Interfaces:
ActiveToolManager, ToolManager

public class ActiveToolComponent
extends ToolComponent
implements ActiveToolManager

ToolComponent is the standard implementation of the Sakai Tool API.

Version:
$Revision: 5918 $
Author:
University of Michigan, Sakai Software Development Team

Nested Class Summary
 class ActiveToolComponent.MyActiveTool
          Entity: ActiveTool
 
Field Summary
 
Fields inherited from class org.sakaiproject.component.kernel.tool.ToolComponent
CURRENT_PLACEMENT, CURRENT_TOOL, m_stealthToolIds, m_threadLocalManager, m_tools
 
Constructor Summary
ActiveToolComponent()
           
 
Method Summary
 ActiveTool getActiveTool(String id)
          Find a tool with this well known id in the registry.
 void register(Document toolXml, ServletContext context)
          Add tools in this XML DOM to the registry, using the Tool XML schema.
 void register(File toolXmlFile, ServletContext context)
          Add tools in this file of Tool XML schema to the registry.
 void register(InputStream toolXmlStream, ServletContext context)
          Add tools in this stream of Tool XML schema to the registry.
 void register(Tool tool, ServletContext context)
          Add this tool to the registry.
 
Methods inherited from class org.sakaiproject.component.kernel.tool.ToolComponent
destroy, findTools, getCurrentPlacement, getCurrentTool, getTool, init, matchCriteria, register, register, register, register, setCurrentPlacement, setCurrentTool, setStealthTools, setThreadLocalManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.sakaiproject.api.kernel.tool.ToolManager
findTools, getCurrentPlacement, getCurrentTool, getTool, register, register, register, register
 

Constructor Detail

ActiveToolComponent

public ActiveToolComponent()
Method Detail

register

public void register(Tool tool,
                     ServletContext context)
Description copied from interface: ActiveToolManager
Add this tool to the registry.

Specified by:
register in interface ActiveToolManager
Parameters:
tool - The Tool to register.

register

public void register(Document toolXml,
                     ServletContext context)
Description copied from interface: ActiveToolManager
Add tools in this XML DOM to the registry, using the Tool XML schema.

Specified by:
register in interface ActiveToolManager
Parameters:
toolXml - The parsed XML DOM in which tools to be added to the registry are to be found.

register

public void register(File toolXmlFile,
                     ServletContext context)
Description copied from interface: ActiveToolManager
Add tools in this file of Tool XML schema to the registry.

Specified by:
register in interface ActiveToolManager
Parameters:
toolXmlFile - The file of Tool schema XML in which tools to be added to the registry are to be found.

register

public void register(InputStream toolXmlStream,
                     ServletContext context)
Description copied from interface: ActiveToolManager
Add tools in this stream of Tool XML schema to the registry.

Specified by:
register in interface ActiveToolManager

getActiveTool

public ActiveTool getActiveTool(String id)
Description copied from interface: ActiveToolManager
Find a tool with this well known id in the registry.

Specified by:
getActiveTool in interface ActiveToolManager
Parameters:
id - The tool's well known id.
Returns:
The Tool object that has this id, or null if not found.