org.sakaiproject.tool.impl

Class ActiveToolComponent

java.lang.Object

org.sakaiproject.tool.impl.ToolComponent

org.sakaiproject.tool.impl.ActiveToolComponent

All Implemented Interfaces:

ActiveToolManager, ToolManager

public abstract class ActiveToolComponent
extends ToolComponent
implements ActiveToolManager

ActiveToolComponent is the standard implementation of the Sakai ActiveTool API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ActiveToolComponent.MyActiveTool Entity: ActiveTool

Field Summary

Fields

Modifier and Type	Field and Description
static String	TOOL_PORTLET_CONTEXT_PATH

Fields inherited from class org.sakaiproject.tool.impl.ToolComponent

CURRENT_PLACEMENT, CURRENT_TOOL, m_hiddenToolIds, m_stealthToolIds, m_toolIdsToHide, m_tools, m_visibleToolIds, PORTAL_VISIBLE, TOOLCONFIG_REQUIRED_PERMISSIONS

Constructor Summary

Constructors

Constructor and Description
ActiveToolComponent()

Method Summary

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

Methods inherited from class org.sakaiproject.tool.impl.ToolComponent

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.sakaiproject.tool.api.ToolManager

allowTool, findTools, getCurrentPlacement, getCurrentTool, getLocalizedToolProperty, getTool, isHidden, isVisible, register, register, register, register, setResourceBundle

Field Detail

TOOL_PORTLET_CONTEXT_PATH

public static final String TOOL_PORTLET_CONTEXT_PATH

See Also:

Constant Field Values

Constructor Detail

ActiveToolComponent

public ActiveToolComponent()

Method Detail

sessionManager

protected abstract SessionManager sessionManager()

Returns:

the SessionManager collaborator.

functionManager

protected abstract FunctionManager functionManager()

Returns:

the FunctionManager collaborator.

serverConfigurationService

protected abstract ServerConfigurationService serverConfigurationService()

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.

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

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.

parseTools

public List<Tool> parseTools(File toolXmlFile)

Description copied from interface: ActiveToolManager

Parse a registration file and return a list of Tool Registrations

Specified by:

parseTools in interface ActiveToolManager

Parameters:

toolXmlFile - The file of Tool schema XML in which tools to be added to the registry are to be found.

parseTools

public List<Tool> parseTools(InputStream toolXmlStream)

Description copied from interface: ActiveToolManager

Parse a registration file and return a list of Tool Registrations

Specified by:

parseTools in interface ActiveToolManager

Parameters:

toolXmlStream - The file of Tool schema XML in which tools to be added to the registry are to be found.

parseTools

public List<Tool> parseTools(Document toolXml)

Description copied from interface: ActiveToolManager

Parse a registration file and return a list of Tool Registrations

Specified by:

parseTools in interface ActiveToolManager

Parameters:

toolXml - The file of Tool schema XML 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

Parameters:

toolXmlStream - The file of Tool schema XML in which tools to be added to the registry are to be found.

context - the Servlet context

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.