org.sakaiproject.portal.tool
Class ToolPortal

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.sakaiproject.portal.tool.ToolPortal

All Implemented Interfaces:

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

public class ToolPortal
extends javax.servlet.http.HttpServlet

Since:

Sakai 2.4

Version:

$Rev: 110562 $

Author:

ieb

See Also:

Serialized Form

Constructor Summary

ToolPortal()

Method Summary

void	destroy() Shutdown the servlet.
protected void	doError(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, Throwable t)
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Respond to navigation / access requests.
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Respond to data posting requests.
protected boolean	doTool(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, org.sakaiproject.tool.api.Session session, String placementId, String toolContextPath, String toolPathInfo) Process a tool request
String	getServletInfo() Access the Servlet's information display.
void	init(javax.servlet.ServletConfig config) Initialize the servlet.
protected void	setupForward(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, org.sakaiproject.tool.api.Placement p, String skin) Setup the request attributes with information used by the tools in their response.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolPortal

public ToolPortal()

Method Detail

getServletInfo

public String getServletInfo()

Access the Servlet's information display.

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class javax.servlet.GenericServlet

Returns:

servlet information.

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Initialize the servlet.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Parameters:

config - The servlet config.

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Shutdown the servlet.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

doGet

protected void doGet(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse res)
              throws javax.servlet.ServletException,
                     IOException

Respond to navigation / access requests.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

req - The servlet request.

res - The servlet response.

Throws:

ServletException.

IOException.

javax.servlet.ServletException

IOException

doTool

protected boolean doTool(javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse res,
                         org.sakaiproject.tool.api.Session session,
                         String placementId,
                         String toolContextPath,
                         String toolPathInfo)
                  throws org.sakaiproject.tool.api.ToolException,
                         IOException

Process a tool request

Parameters:

req -

res -

session -

placementId -

toolContextPath -

toolPathInfo -

Returns:

true if the processing was successful, false if nt

Throws:

org.sakaiproject.tool.api.ToolException

IOException

doError

protected void doError(javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse res,
                       Throwable t)

doPost

protected void doPost(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse res)
               throws javax.servlet.ServletException,
                      IOException

Respond to data posting requests.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

req - The servlet request.

res - The servlet response.

Throws:

ServletException.

IOException.

javax.servlet.ServletException

IOException

setupForward

protected void setupForward(javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse res,
                            org.sakaiproject.tool.api.Placement p,
                            String skin)
                     throws org.sakaiproject.tool.api.ToolException

Setup the request attributes with information used by the tools in their response.

Parameters:

req -

res -

p -

skin -

Throws:

org.sakaiproject.tool.api.ToolException