| org.sakaiproject.tool.api.ActiveTool
ActiveTool | public interface ActiveTool extends Tool(Code) | |
Extension to tool to introduce Servlet API specific tool activity.
|
Method Summary | |
void | forward(HttpServletRequest req, HttpServletResponse res, Placement placement, String toolContext, String toolPath) | 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) |
TOOL_ATTR_CURRENT_DESTINATION | final static String TOOL_ATTR_CURRENT_DESTINATION(Code) | | A tool session attribute where the placement's current destination (URL path) is stored.
|
forward | void forward(HttpServletRequest req, HttpServletResponse res, Placement placement, String toolContext, String toolPath) throws ToolException(Code) | | Invoke the tool to handle the complete request
Parameters: req - The request. Parameters: res - The response. Parameters: placement - The tool placement for this request. Parameters: toolContext - The (optional) servlet context path that is given to the tool. Parameters: toolPath - The (optional) servlet pathInfo that is given to the tool. throws: ToolException - if there's any trouble running the tool. |
help | void help(HttpServletRequest req, HttpServletResponse res, String toolContext, String toolPath) throws ToolException(Code) | | Invoke the tool to handle the complete request as a helper. Note, the placement is shared between invoker and invoked.
Parameters: req - The request. Parameters: res - The response. Parameters: toolContext - The (optional) servlet context path that is given to the tool. Parameters: toolPath - The (optional) servlet pathInfo that is given to the tool. throws: ToolException - if there's any trouble running the tool. |
include | void include(HttpServletRequest req, HttpServletResponse res, Placement placement, String toolContext, String toolPath) throws ToolException(Code) | | Invoke the tool to handle the request by producing a fragment
Parameters: req - The request. Parameters: res - The response. Parameters: placement - The tool placement for this request. Parameters: toolContext - The (optional) servlet context path that is given to the tool. Parameters: toolPath - The (optional) servlet pathInfo that is given to the tool. throws: ToolException - if there's any trouble running the tool. |
|
|