ToolServlet (sakai-velocity-tool 20.1 API)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - org.sakaiproject.vm.ComponentServlet
    - - org.sakaiproject.vm.VmServlet
      - org.sakaiproject.cheftool.VmServlet
        
        org.sakaiproject.cheftool.ToolServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

VelocityPortletPaneledAction
```
public abstract class ToolServlet
extends VmServlet
```
ToolServlet is a Servlet that support CHEF tools.

Extending VmServlet provides support for component location and use of the Velocity Template Engine.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ALERT_ATTR` The state attribute name used to store the Alert.
`protected static String`	`ALERT_STATE_INITED` The state attribute name used to store the marker of have been initialized.
`protected static String`	`HELPER_ID` ToolSession attribute name holding the helper id, if we are in helper mode.
`protected String`	`MAIN_PANEL` The special panel name for the main.
`protected static String`	`MENU_ATTR` The state attribute name used to store the Menu.
`protected static String`	`PARAM_ACTION` The request parameter name whose value is the action.
`protected static String`	`PARAM_ACTION_COMBO` The request parameter name root that has the action name following.
`protected String`	`TITLE_PANEL` The special panel name for the title.
`protected String`	`TOOL_MODE_ATTR` The mode attribute name base - postfix with the portlet mode.
`protected String`	`TOOL_MODE_DEFAULT` The mode value when no mode has been set.

Fields inherited from class org.sakaiproject.cheftool.VmServlet
m_validator

Fields inherited from class org.sakaiproject.vm.ComponentServlet
ATTR_PARAMS

Constructor Summary

Constructors
Constructor and Description

ToolServlet()

Constructors
Constructor and Description
`ToolServlet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`actionDispatch(String methodBase, String methodExt, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` Dispatch to a "processAction" method based on reflection.
`protected void`	`doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` Respond to a request by dispatching to a portlet like "do" method based on the portlet mode and tool mode
`protected void`	`doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` Respond to a request by dispatching to a portlet like "do" method based on the portlet mode and tool mode
`protected Alert`	`getAlert(javax.servlet.http.HttpServletRequest req)` Access the Alert for the current request.
`protected Alert`	`getAlert(SessionState state)` Access the Alert in this state - will create one if needed.
`protected Menu`	`getMenu(javax.servlet.http.HttpServletRequest req)` Access the Menu for the current request.
`protected String`	`getPid(javax.servlet.http.HttpServletRequest req)` Access the "pid" - portlet window id, tool id, from the request
`protected SessionState`	`getState(javax.servlet.http.HttpServletRequest req)` Access the SessionState for the current request.
`protected String`	`getToolMode(javax.servlet.http.HttpServletRequest req)` Access the tool mode for the current Portlet mode.
`protected void`	`initState(SessionState state, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` Initialize for the first time the session state for this session.
`protected void`	`prepState(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` Prepare state, either for first time or update
`protected void`	`processAction(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` Process a Portlet action.
`protected boolean`	`sendToHelper(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String target)`
`protected void`	`setToolMode(String toolMode, javax.servlet.http.HttpServletRequest req)` Set the tool mode.
`protected void`	`setVmStdRef(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Add some standard references to the vm context.
`protected void`	`startHelper(javax.servlet.http.HttpServletRequest req, String helperId)` Setup for a helper tool - all subsequent requests will be directed there, till the tool is done.
`protected void`	`startHelper(javax.servlet.http.HttpServletRequest req, String helperId, String panel)` Setup for a helper tool - all subsequent requests will be directed there, till the tool is done.
`protected void`	`toolModeDispatch(String methodBase, String methodExt, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` Dispatch to a "do" method based on reflection.
`protected void`	`updateState(SessionState state, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` Update for this request processing the session state.

Methods inherited from class org.sakaiproject.vm.VmServlet
getActionURL, getVmReference, includeVm, setVmReference

Methods inherited from class org.sakaiproject.vm.ComponentServlet
sendParentRedirect, service, setNoCacheHeaders

Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HELPER_ID
```
protected static final String HELPER_ID
```
    ToolSession attribute name holding the helper id, if we are in helper mode. NOTE: promote to Tool -ggolden
    
    See Also:
    
    Constant Field Values
  - TOOL_MODE_DEFAULT
```
protected final String TOOL_MODE_DEFAULT
```
    The mode value when no mode has been set.
    
    See Also:
    
    Constant Field Values
  - TOOL_MODE_ATTR
```
protected final String TOOL_MODE_ATTR
```
    The mode attribute name base - postfix with the portlet mode.
    
    See Also:
    
    Constant Field Values
  - TITLE_PANEL
```
protected final String TITLE_PANEL
```
    The special panel name for the title.
    
    See Also:
    
    Constant Field Values
  - MAIN_PANEL
```
protected final String MAIN_PANEL
```
    The special panel name for the main.
    
    See Also:
    
    Constant Field Values
  - PARAM_ACTION_COMBO
```
protected static final String PARAM_ACTION_COMBO
```
    The request parameter name root that has the action name following.
    
    See Also:
    
    Constant Field Values
  - PARAM_ACTION
```
protected static final String PARAM_ACTION
```
    The request parameter name whose value is the action.
    
    See Also:
    
    Constant Field Values
  - ALERT_STATE_INITED
```
protected static final String ALERT_STATE_INITED
```
    The state attribute name used to store the marker of have been initialized.
    
    See Also:
    
    Constant Field Values
  - ALERT_ATTR
```
protected static final String ALERT_ATTR
```
    The state attribute name used to store the Alert.
    
    See Also:
    
    Constant Field Values
  - MENU_ATTR
```
protected static final String MENU_ATTR
```
    The state attribute name used to store the Menu.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ToolServlet
```
public ToolServlet()
```
- Method Detail
  - setVmStdRef
```
protected void setVmStdRef(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
```
    Add some standard references to the vm context.
    
    Overrides:
    
    setVmStdRef in class VmServlet
    
    Parameters:
    
    request - The render request.
    
    response - The render response.
  - setToolMode
```
protected void setToolMode(String toolMode,
                           javax.servlet.http.HttpServletRequest req)
```
    Set the tool mode.
    
    Parameters:
    
    toolMode - The new tool mode.
    
    req - The portlet request.
  - getToolMode
```
protected String getToolMode(javax.servlet.http.HttpServletRequest req)
```
    Access the tool mode for the current Portlet mode.
    
    Parameters:
    
    req - The portlet request.
    
    Returns:
    
    the tool mode for the current Portlet mode.
  - doPost
```
protected void doPost(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse res)
               throws javax.servlet.ServletException
```
    Respond to a request by dispatching to a portlet like "do" method based on the portlet mode and tool mode
    
    Overrides:
    
    doPost in class javax.servlet.http.HttpServlet
    
    Throws:
    
    javax.servlet.ServletException
  - doGet
```
protected void doGet(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse res)
              throws javax.servlet.ServletException
```
    Respond to a request by dispatching to a portlet like "do" method based on the portlet mode and tool mode
    
    Overrides:
    
    doGet in class javax.servlet.http.HttpServlet
    
    Throws:
    
    javax.servlet.ServletException
  - startHelper
```
protected void startHelper(javax.servlet.http.HttpServletRequest req,
                           String helperId,
                           String panel)
```
    Setup for a helper tool - all subsequent requests will be directed there, till the tool is done.
    
    Parameters:
    
    helperId - The helper tool id.
  - startHelper
```
protected void startHelper(javax.servlet.http.HttpServletRequest req,
                           String helperId)
```
    Setup for a helper tool - all subsequent requests will be directed there, till the tool is done.
    
    Parameters:
    
    helperId - The helper tool id.
  - toolModeDispatch
```
protected void toolModeDispatch(String methodBase,
                                String methodExt,
                                javax.servlet.http.HttpServletRequest req,
                                javax.servlet.http.HttpServletResponse res)
                         throws ToolException
```
    Dispatch to a "do" method based on reflection.
    
    Parameters:
    
    methodBase - The base name of the method to call.
    
    methodExt - The end name of the method to call.
    
    req - The HttpServletRequest.
    
    res - The HttpServletResponse
    
    Throws:
    
    PortletExcption, - IOException, just like the "do" methods.
    
    ToolException
  - processAction
```
protected void processAction(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse res)
```
    Process a Portlet action.
  - actionDispatch
```
protected void actionDispatch(String methodBase,
                              String methodExt,
                              javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse res)
```
    Dispatch to a "processAction" method based on reflection.
    
    Parameters:
    
    methodBase - The base name of the method to call.
    
    methodExt - The end name of the method to call.
    
    req - The ActionRequest.
    
    res - The ActionResponse
    
    Throws:
    
    PortletExcption, - IOException, just like the "do" methods.
  - getPid
```
protected String getPid(javax.servlet.http.HttpServletRequest req)
```
    Access the "pid" - portlet window id, tool id, from the request
    
    Parameters:
    
    req - The current request.
    
    Returns:
    
    the "pid" - portlet window id, tool id, from the request
  - getState
```
protected SessionState getState(javax.servlet.http.HttpServletRequest req)
```
    Access the SessionState for the current request. Note: this is scoped only for the current request.
    
    Parameters:
    
    req - The current portlet request.
    
    Returns:
    
    The SessionState objet for the current request.
  - prepState
```
protected void prepState(javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse res)
```
    Prepare state, either for first time or update
    
    Parameters:
    
    req - The current portlet request.
    
    res - The current response.
  - initState
```
protected void initState(SessionState state,
                         javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse res)
```
    Initialize for the first time the session state for this session. If overridden in a sub-class, make sure to call super.
    
    Parameters:
    
    state - The session state.
    
    req - The current request.
    
    res - The current response.
  - updateState
```
protected void updateState(SessionState state,
                           javax.servlet.http.HttpServletRequest req,
                           javax.servlet.http.HttpServletResponse res)
```
    Update for this request processing the session state. If overridden in a sub-class, make sure to call super.
    
    Parameters:
    
    state - The session state.
    
    req - The current request.
    
    res - The current response.
  - getAlert
```
protected Alert getAlert(javax.servlet.http.HttpServletRequest req)
```
    Access the Alert for the current request.
    
    Parameters:
    
    req - The current portlet request.
    
    Returns:
    
    The Alert objet for the current request.
  - getAlert
```
protected Alert getAlert(SessionState state)
```
    Access the Alert in this state - will create one if needed.
    
    Parameters:
    
    state - The state in which to find the alert.
    
    Returns:
    
    The Alert objet.
  - getMenu
```
protected Menu getMenu(javax.servlet.http.HttpServletRequest req)
```
    Access the Menu for the current request.
    
    Parameters:
    
    req - The current portlet request.
    
    Returns:
    
    The Menu objet for the current request.
  - sendToHelper
```
protected boolean sendToHelper(javax.servlet.http.HttpServletRequest req,
                               javax.servlet.http.HttpServletResponse res,
                               String target)
                        throws ToolException
```
    Parameters:
    
    req -
    
    res -
    
    target -
    
    Returns:
    
    Throws:
    
    ToolException

Class ToolServlet

Field Summary

Fields inherited from class org.sakaiproject.cheftool.VmServlet

Fields inherited from class org.sakaiproject.vm.ComponentServlet

Constructor Summary

Method Summary

Methods inherited from class org.sakaiproject.vm.VmServlet

Methods inherited from class org.sakaiproject.vm.ComponentServlet

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Field Detail

HELPER_ID

TOOL_MODE_DEFAULT

TOOL_MODE_ATTR

TITLE_PANEL

MAIN_PANEL

PARAM_ACTION_COMBO

PARAM_ACTION

ALERT_STATE_INITED

ALERT_ATTR

MENU_ATTR

Constructor Detail

ToolServlet

Method Detail

setVmStdRef

setToolMode

getToolMode

doPost

doGet

startHelper

startHelper

toolModeDispatch

processAction

actionDispatch

getPid

getState

prepState

initState

updateState

getAlert

getAlert

getMenu

sendToHelper