| javax.servlet.http.HttpServlet org.sakaiproject.portal.charon.SkinnableCharonPortal
SkinnableCharonPortal | public class SkinnableCharonPortal extends HttpServlet implements Portal(Code) | | Charon is the Sakai Site based portal.
since: Sakai 2.4 version: $Rev: 29143 $ |
Method Summary | |
public String | calcSiteType(String siteId) Returns the type ("course", "project", "workspace", "mySpecialSiteType",
etc) of the given site; special handling of returning "workspace" for
user workspace sites. | public Map | convertSiteToMap(HttpServletRequest req, Site s, String prefix, String currentSiteId, String myWorkspaceSiteId, boolean includeSummary, boolean expandSite, boolean resetTools, boolean doPages, String toolContextPath, boolean loggedIn) | public List<Map> | convertSitesToMaps(HttpServletRequest req, List mySites, String prefix, String currentSiteId, String myWorkspaceSiteId, boolean includeSummary, boolean expandSite, boolean resetTools, boolean doPages, String toolContextPath, boolean loggedIn) | public void | destroy() Shutdown the servlet. | public void | doError(HttpServletRequest req, HttpServletResponse res, Session session, int mode) | protected void | doGet(HttpServletRequest req, HttpServletResponse res) Respond to navigation / access requests.
Parameters: req - The servlet request. Parameters: res - The servlet response. | public void | doLogin(HttpServletRequest req, HttpServletResponse res, Session session, String returnPath, boolean skipContainer) | public void | doLogout(HttpServletRequest req, HttpServletResponse res, Session session, String returnPath) Process a logout
Parameters: req - Request object Parameters: res - Response object Parameters: session - Current session Parameters: returnPath - if not null, the path to use for the end-user browser redirectafter the logout is complete. | protected void | doPost(HttpServletRequest req, HttpServletResponse res) Respond to data posting requests. | protected void | doThrowableError(HttpServletRequest req, HttpServletResponse res, Throwable t) | public void | forwardPortal(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, ToolConfiguration p, String skin, String toolContextPath, String toolPathInfo) | public void | forwardTool(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, Placement p, String skin, String toolContextPath, String toolPathInfo) | public String | getPlacement(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, boolean doPage) | public String | getPortalContext() | public String | getPortalPageUrl(ToolConfiguration p) | protected String | getScriptPath() | public String | getServletInfo() Access the Servlet's information display. | public String | getUserEidBasedSiteId(String userId) | public void | includeBottom(PortalRenderContext rcontext) | public void | includeLogin(PortalRenderContext rcontext, HttpServletRequest req, Session session) | public PortalRenderContext | includePortal(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String toolId, String toolContextPath, String prefix, boolean doPages, boolean resetTools, boolean includeSummary, boolean expandSite) | public Map | includeTool(HttpServletResponse res, HttpServletRequest req, ToolConfiguration placement) | public void | includeWorksite(PortalRenderContext rcontext, HttpServletResponse res, HttpServletRequest req, Session session, Site site, SitePage page, String toolContextPath, String portalPrefix) | public void | init(ServletConfig config) Initialize the servlet. | public boolean | isPortletPlacement(Placement placement) | protected Map | pageListToMap(HttpServletRequest req, boolean loggedIn, Site site, SitePage page, String toolContextPath, String portalPrefix, boolean doPages, boolean resetTools, boolean includeSummary) | protected void | postLogin(HttpServletRequest req, HttpServletResponse res, Session session, String loginPath) | public boolean | redirectIfLoggedOut(HttpServletResponse res) | protected void | sendPortalRedirect(HttpServletResponse res, String url) Send a redirect so our Portal window ends up at the url, via javascript. | public void | sendResponse(PortalRenderContext rcontext, HttpServletResponse res, String template, String contentType) | public void | setupForward(HttpServletRequest req, HttpServletResponse res, Placement p, String skin) | protected void | showSession(PortalRenderContext rcontext, boolean html) | public PortalRenderContext | startPageContext(String siteType, String title, String skin, HttpServletRequest request) |
PARAM_SAKAI_SITE | final protected static String PARAM_SAKAI_SITE(Code) | | Parameter value to indicate to look up a tool ID within a site
|
calcSiteType | public String calcSiteType(String siteId)(Code) | | Returns the type ("course", "project", "workspace", "mySpecialSiteType",
etc) of the given site; special handling of returning "workspace" for
user workspace sites. This method is tightly coupled to site skinning.
|
convertSiteToMap | public Map convertSiteToMap(HttpServletRequest req, Site s, String prefix, String currentSiteId, String myWorkspaceSiteId, boolean includeSummary, boolean expandSite, boolean resetTools, boolean doPages, String toolContextPath, boolean loggedIn)(Code) | | |
convertSitesToMaps | public List<Map> convertSitesToMaps(HttpServletRequest req, List mySites, String prefix, String currentSiteId, String myWorkspaceSiteId, boolean includeSummary, boolean expandSite, boolean resetTools, boolean doPages, String toolContextPath, boolean loggedIn)(Code) | | |
destroy | public void destroy()(Code) | | Shutdown the servlet.
|
doLogout | public void doLogout(HttpServletRequest req, HttpServletResponse res, Session session, String returnPath) throws ToolException(Code) | | Process a logout
Parameters: req - Request object Parameters: res - Response object Parameters: session - Current session Parameters: returnPath - if not null, the path to use for the end-user browser redirectafter the logout is complete. Leave null to use the configuredlogged out URL. throws: IOException - |
getServletInfo | public String getServletInfo()(Code) | | Access the Servlet's information display.
servlet information. |
getUserEidBasedSiteId | public String getUserEidBasedSiteId(String userId)(Code) | | Compute the string that will identify the user site for this user - use
the EID if possible
Parameters: userId - The user id The site "ID" but based on the user EID |
includePortal | public PortalRenderContext includePortal(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String toolId, String toolContextPath, String prefix, boolean doPages, boolean resetTools, boolean includeSummary, boolean expandSite) throws ToolException, IOException(Code) | | |
isPortletPlacement | public boolean isPortletPlacement(Placement placement)(Code) | | |
redirectIfLoggedOut | public boolean redirectIfLoggedOut(HttpServletResponse res) throws IOException(Code) | | Check for any just expired sessions and redirect
true if we redirected, false if not |
sendPortalRedirect | protected void sendPortalRedirect(HttpServletResponse res, String url) throws IOException(Code) | | Send a redirect so our Portal window ends up at the url, via javascript.
Parameters: url - The redirect url |
showSession | protected void showSession(PortalRenderContext rcontext, boolean html)(Code) | | Output some session information
Parameters: rcontext - 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)
|
|
|