| javax.servlet.http.HttpServlet
 org.sakaiproject.portal.tool.MercuryPortal
| MercuryPortal | | public class MercuryPortal extends HttpServlet (Code) | |
Mercury is the Sakai developers portal. It can be used while developing a new Sakai application to invoke the tool in the way that the tool will be
invoked by any of the Sakai navigation / portal technologies. Mercury is easier to use in development because you don't have to setup a Site or
build SuperStructure to test your application.
Mercury supports a few URL patterns, but those give you the ability to:
- login to Sakai
- see all registered tools
- visit any tool complete with context and placement
Mercury is configured to be packaged into the "mercury.war" web application, so it can be visited with the /mercury URL.
To login, use the /mercury/login URL.
To visit any registered tool, use the URL pattern:
/mercury/TOOL-ID/CONTEXT/path-for-tool
where TOOL_ID is the tool's well known registered tool id (such as 'sakai.chat'), and CONTEXT is the tool context string.
A placement will be created for each tool in the context as needed, and will be tracked for the duration of the server run.
|
| Field Summary | |
| protected Map | m_placements
Map of context+toolId -> Placement for keeping tool placements. |
| Method Summary | |
| public void | destroy()
Shutdown the servlet. | | protected void | doDisabled(HttpServletRequest req, HttpServletResponse res)
| | protected void | doError(HttpServletRequest req, HttpServletResponse res, Session session)
| | protected void | doGet(HttpServletRequest req, HttpServletResponse res)
Respond to navigation / access requests.
Parameters:
req - The servlet request.
Parameters:
res - The servlet response. | | protected void | doHome(HttpServletRequest req, HttpServletResponse res, Session session)
| | protected void | doLogin(HttpServletRequest req, HttpServletResponse res, Session session)
| | protected void | doLoginx(HttpServletRequest req, HttpServletResponse res, String which, Session session)
| | protected void | doLogout(HttpServletRequest req, HttpServletResponse res, Session session)
| | protected void | doPost(HttpServletRequest req, HttpServletResponse res)
Respond to data posting requests.
Parameters:
req - The servlet request.
Parameters:
res - The servlet response. | | protected void | doThrowableError(HttpServletRequest req, HttpServletResponse res, Throwable t)
| | protected void | doTool(HttpServletRequest req, HttpServletResponse res, Session session, String toolId, String context, String toolContextPath, String toolPathInfo)
| | protected void | forwardTool(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, Placement p, String toolContextPath, String toolPathInfo)
| | public String | getServletInfo()
Access the Servlet's information display. | | public void | init(ServletConfig config)
Initialize the servlet. | | protected void | postHome(HttpServletRequest req, HttpServletResponse res, Session session)
| | protected void | postLogin(HttpServletRequest req, HttpServletResponse res, Session session)
| | protected void | postTool(HttpServletRequest req, HttpServletResponse res, Session session, String toolId, String context, String toolContextPath, String toolPathInfo)
| | protected String | printCategories(Set categories)
Format the tool's categories
Parameters:
categories - The categories set. | | protected String | printConfiguration(Properties config)
Format the tool's configuration parameters
Parameters:
t - The tool. | | protected String | printKeywords(Set keywords)
Format the tool's keywords
Parameters:
keywords - The keywords set. | | protected void | showSession(PrintWriter out, boolean html)
|
| m_placements | | protected Map m_placements(Code) | | Map of context+toolId -> Placement for keeping tool placements.
|
| destroy | | public void destroy()(Code) | | Shutdown the servlet.
|
| getServletInfo | | public String getServletInfo()(Code) | | Access the Servlet's information display.
servlet information. |
| printCategories | | protected String printCategories(Set categories)(Code) | | Format the tool's categories
Parameters:
categories - The categories set. The tool's categories, formatted for HTML display. |
| printConfiguration | | protected String printConfiguration(Properties config)(Code) | | Format the tool's configuration parameters
Parameters:
t - The tool. The tool's configuration parameters, formatted for HTML display. |
| printKeywords | | protected String printKeywords(Set keywords)(Code) | | Format the tool's keywords
Parameters:
keywords - The keywords set. The tool's keywords, formatted for HTML display. |
| showSession | | protected void showSession(PrintWriter out, boolean html)(Code) | | Output some session information
Parameters:
out - The print writer
Parameters:
html - If true, output in HTML, else in text. |
| Methods inherited from javax.servlet.http.HttpServlet | protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doHead(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doOptions(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doTrace(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected long getLastModified(HttpServletRequest req)(Code)(Java Doc)
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException(Code)(Java Doc)
|
|
|