public abstract class ActiveToolComponent extends ToolComponent implements ActiveToolManager
ActiveToolComponent is the standard implementation of the Sakai ActiveTool API.
Modifier and Type | Class and Description |
---|---|
class |
ActiveToolComponent.MyActiveTool
Entity: ActiveTool
|
Modifier and Type | Field and Description |
---|---|
static String |
TOOL_PORTLET_CONTEXT_PATH |
CURRENT_PLACEMENT, CURRENT_TOOL, m_hiddenToolIds, m_stealthToolIds, m_toolIdsToHide, m_tools, m_visibleToolIds, PORTAL_VISIBLE, TOOLCONFIG_REQUIRED_PERMISSIONS
Constructor and Description |
---|
ActiveToolComponent() |
Modifier and Type | Method and Description |
---|---|
protected abstract FunctionManager |
functionManager() |
ActiveTool |
getActiveTool(String id)
Find a tool with this well known id in the registry.
|
List<Tool> |
parseTools(Document toolXml)
Parse a registration file and return a list of Tool Registrations
|
List<Tool> |
parseTools(File toolXmlFile)
Parse a registration file and return a list of Tool Registrations
|
List<Tool> |
parseTools(InputStream toolXmlStream)
Parse a registration file and return a list of Tool Registrations
|
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.
|
protected abstract ServerConfigurationService |
serverConfigurationService() |
protected abstract SessionManager |
sessionManager() |
allowTool, allowToolHelper, destroy, findTools, getCurrentPlacement, getCurrentTool, getLocalizedToolProperty, getTool, init, isHidden, isVisible, matchCriteria, register, register, register, register, securityService, setCurrentPlacement, setCurrentTool, setHiddenTools, setResourceBundle, setResourceLoader, setStealthTools, setVisibleTools, threadLocalManager
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
allowTool, findTools, getCurrentPlacement, getCurrentTool, getLocalizedToolProperty, getTool, isHidden, isVisible, register, register, register, register, setResourceBundle
public static final String TOOL_PORTLET_CONTEXT_PATH
protected abstract SessionManager sessionManager()
protected abstract FunctionManager functionManager()
protected abstract ServerConfigurationService serverConfigurationService()
public void register(Tool tool, ServletContext context)
ActiveToolManager
register
in interface ActiveToolManager
tool
- The Tool to register.context
- The ServletContext to be attached to the tool. Only applied to the default implementation,
as supplied through the XML signatures (usually via the ToolListener), or a bare Tool instance,
which will be decorated. Ignored if supplying a custom ActiveTool implementation (or proxy).public void register(Document toolXml, ServletContext context)
ActiveToolManager
register
in interface ActiveToolManager
toolXml
- The parsed XML DOM in which tools to be added to the registry are to be found.public List<Tool> parseTools(File toolXmlFile)
ActiveToolManager
parseTools
in interface ActiveToolManager
toolXmlFile
- The file of Tool schema XML in which tools to be added to the registry are to be found.public List<Tool> parseTools(InputStream toolXmlStream)
ActiveToolManager
parseTools
in interface ActiveToolManager
toolXmlStream
- The file of Tool schema XML in which tools to be added to the registry are to be found.public List<Tool> parseTools(Document toolXml)
ActiveToolManager
parseTools
in interface ActiveToolManager
toolXml
- The file of Tool schema XML in which tools to be added to the registry are to be found.public void register(File toolXmlFile, ServletContext context)
ActiveToolManager
register
in interface ActiveToolManager
toolXmlFile
- The file of Tool schema XML in which tools to be added to the registry are to be found.public void register(InputStream toolXmlStream, ServletContext context)
ActiveToolManager
register
in interface ActiveToolManager
toolXmlStream
- The file of Tool schema XML in which tools to be added to the registry are to be found.context
- the Servlet contextpublic ActiveTool getActiveTool(String id)
ActiveToolManager
getActiveTool
in interface ActiveToolManager
id
- The tool's well known id.Copyright © 2003–2019 The Sakai Foundation. All rights reserved.