org.sakaiproject.api.kernel.tool
Interface ActiveTool

All Superinterfaces:
Tool
All Known Implementing Classes:
ActiveToolComponent.MyActiveTool

public interface ActiveTool
extends Tool

Extension to tool to introduce Servlet API specific tool activity.

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

Nested Class Summary
 
Nested classes inherited from class org.sakaiproject.api.kernel.tool.Tool
Tool.AccessSecurity
 
Field Summary
 
Fields inherited from interface org.sakaiproject.api.kernel.tool.Tool
FRAGMENT, HELPER_DONE_URL, HELPER_MESSAGE, NATIVE_URL, PLACEMENT, PLACEMENT_ID, PORTLET, TOOL, TOOL_SESSION
 
Method Summary
 void forward(HttpServletRequest req, HttpServletResponse res, Placement placement, String toolContext, String toolPath)
          Invoke the tool to handle the complete request
 void help(HttpServletRequest req, HttpServletResponse res, String toolContext, String toolPath)
          Invoke the tool to handle the complete request as a helper.
 void include(HttpServletRequest req, HttpServletResponse res, Placement placement, String toolContext, String toolPath)
          Invoke the tool to handle the request by producing a fragment
 
Methods inherited from interface org.sakaiproject.api.kernel.tool.Tool
getAccessSecurity, getCategories, getDescription, getFinalConfig, getId, getKeywords, getMutableConfig, getRegisteredConfig, getTitle
 

Method Detail

forward

public void forward(HttpServletRequest req,
                    HttpServletResponse res,
                    Placement placement,
                    String toolContext,
                    String toolPath)
             throws ToolException
Invoke the tool to handle the complete request

Parameters:
req - The request.
res - The response.
placement - The tool placement for this request.
toolContext - The (optional) servlet context path that is given to the tool.
toolPath - The (optional) servlet pathInfo that is given to the tool.
Throws:
ToolException - if there's any trouble running the tool.

include

public void include(HttpServletRequest req,
                    HttpServletResponse res,
                    Placement placement,
                    String toolContext,
                    String toolPath)
             throws ToolException
Invoke the tool to handle the request by producing a fragment

Parameters:
req - The request.
res - The response.
placement - The tool placement for this request.
toolContext - The (optional) servlet context path that is given to the tool.
toolPath - The (optional) servlet pathInfo that is given to the tool.
Throws:
ToolException - if there's any trouble running the tool.

help

public void help(HttpServletRequest req,
                 HttpServletResponse res,
                 String toolContext,
                 String toolPath)
          throws ToolException
Invoke the tool to handle the complete request as a helper. Note, the placement is shared between invoker and invoked.

Parameters:
req - The request.
res - The response.
toolContext - The (optional) servlet context path that is given to the tool.
toolPath - The (optional) servlet pathInfo that is given to the tool.
Throws:
ToolException - if there's any trouble running the tool.