| javax.servlet.http.HttpServlet org.sakaiproject.portal.charon.CharonPortal
All known Subclasses: org.theospi.portfolio.portal.web.XsltPortal,
CharonPortal | public class CharonPortal extends HttpServlet (Code) | |
Charon is the Sakai Site based portal.
since: Sakai 2.0 version: $Rev: 29196 $ |
Field Summary | |
final protected static String | ATTR_ERROR ThreadLocal attribute set while we are processing an error. | final protected static String | ATTR_SITE_PAGE Session attribute root for storing a site's last page visited - just
append the site id. | final protected static String | CONFIG_AUTO_RESET | final protected static int | ERROR_GALLERY | final protected static int | ERROR_SITE Error response modes. | final protected static int | ERROR_WORKSITE | final protected static String | PARAM_FORCE_LOGIN Parameter value to allow anonymous users of gallery mode to be sent to
the gateway site as anonymous user (like the /portal URL) instead of
making them log in (like worksite, site, and tool URLs). | final protected static String | PARAM_SAKAI_SITE |
Method Summary | |
protected boolean | allowTool(Site site, Placement placement) | protected 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 void | destroy() Shutdown the servlet. | protected void | doDirectTool(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, String toolContextPath, String toolPathInfo) | protected void | doError(HttpServletRequest req, HttpServletResponse res, Session session, int mode) | protected void | doErrorDone(HttpServletRequest req, HttpServletResponse res) | protected void | doErrorReport(HttpServletRequest req, HttpServletResponse res) | protected void | doGallery(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String pageId, String toolContextPath) | protected void | doGalleryTabs(HttpServletRequest req, HttpServletResponse res, Session session, String siteId) | protected void | doGet(HttpServletRequest req, HttpServletResponse res) Respond to navigation / access requests. | protected void | doHelp(HttpServletRequest req, HttpServletResponse res, Session session, String toolContextPath, String toolPathInfo) | protected void | doLogin(HttpServletRequest req, HttpServletResponse res, Session session, String returnPath, boolean skipContainer) | protected 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 | doNavLogin(HttpServletRequest req, HttpServletResponse res, Session session, String siteId) | protected void | doNavLoginGallery(HttpServletRequest req, HttpServletResponse res, Session session, String siteId) | protected void | doPage(HttpServletRequest req, HttpServletResponse res, Session session, String pageId, String toolContextPath) | protected void | doPost(HttpServletRequest req, HttpServletResponse res) Respond to data posting requests. | protected void | doPresence(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String toolContextPath, String toolPathInfo) | protected void | doSite(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String pageId, String toolContextPath) | protected void | doSiteTabs(HttpServletRequest req, HttpServletResponse res, Session session, String siteId) | protected void | doThrowableError(HttpServletRequest req, HttpServletResponse res, Throwable t) | protected void | doTitle(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, String toolContextPath, String toolPathInfo) Title frames were no longer used in 2.3 and are not supported in 2.4 so
these methods are made private to notify derived classes. | protected void | doTool(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, String toolContextPath, String toolPathInfo) | protected void | doWorksite(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String pageId, String toolContextPath) | protected void | endResponse(PrintWriter out) | protected void | forwardPortal(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, ToolConfiguration p, String skin, String toolContextPath, String toolPathInfo) | protected void | forwardTool(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, Placement p, String skin, String toolContextPath, String toolPathInfo) | protected String | getPlacement(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, boolean doPage) | protected String | getPortalPageUrl(ToolConfiguration p) | protected String | getScriptPath() | public String | getServletInfo() Access the Servlet's information display. | protected String | getSiteEffectiveId(Site site) If this is a user site, return an id based on the user EID, otherwise
just return the site id.
Parameters: site - The site. | protected Site | getSiteVisit(String siteId) Do the getSiteVisit, but if not found and the id is a user site, try
translating from user EID to ID.
Parameters: siteId - The Site Id. | protected String | getUserEidBasedSiteId(String userId) | protected void | includeBottom(PrintWriter out) | protected void | includeGalleryLogin(PrintWriter out, HttpServletRequest req, Session session, String siteId) | protected void | includeGalleryNav(PrintWriter out, HttpServletRequest req, Session session, String siteId) | protected void | includeLogin(PrintWriter out, HttpServletRequest req, Session session) | protected void | includeLogo(PrintWriter out, HttpServletRequest req, Session session, String siteId) | protected void | includePage(HttpServletRequest req, HttpServletResponse res, SitePage page, String toolContextPath, String wrapperClass) | protected void | includePageNav(HttpServletRequest req, HttpServletResponse res, Session session, Site site, SitePage page, String toolContextPath, String portalPrefix) | protected void | includeSiteNav(PrintWriter out, HttpServletRequest req, Session session, String siteId) | protected void | includeTabs(PrintWriter out, HttpServletRequest req, Session session, String siteId, String prefix, boolean addLogout) | protected void | includeTitle(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, ToolConfiguration placement, String skin, String toolContextPath, String toolPathInfo) Output the content of the title frame for a tool. | protected void | includeTool(HttpServletRequest req, HttpServletResponse res, ToolConfiguration placement) | protected void | includeWorksite(HttpServletRequest req, HttpServletResponse res, Session session, Site site, SitePage page, String toolContextPath, String portalPrefix) | protected int | indexOf(String value, List siteList) Find the site in the list that has this id - return the position.
Parameters: value - The site id to find. Parameters: siteList - The list of Site objects. | public void | init(ServletConfig config) Initialize the servlet. | protected void | postLogin(HttpServletRequest req, HttpServletResponse res, Session session, String loginPath) | protected 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. | protected void | setupForward(HttpServletRequest req, HttpServletResponse res, Placement p, String skin) | protected void | showSession(PrintWriter out, boolean html) | protected PrintWriter | startResponse(HttpServletResponse res, String title, String skin, boolean top) |
ATTR_ERROR | final protected static String ATTR_ERROR(Code) | | ThreadLocal attribute set while we are processing an error.
|
ATTR_SITE_PAGE | final protected static String ATTR_SITE_PAGE(Code) | | Session attribute root for storing a site's last page visited - just
append the site id.
|
CONFIG_AUTO_RESET | final protected static String CONFIG_AUTO_RESET(Code) | | Configuration option to enable/disable state reset on navigation change
|
ERROR_GALLERY | final protected static int ERROR_GALLERY(Code) | | |
ERROR_SITE | final protected static int ERROR_SITE(Code) | | Error response modes.
|
ERROR_WORKSITE | final protected static int ERROR_WORKSITE(Code) | | |
PARAM_FORCE_LOGIN | final protected static String PARAM_FORCE_LOGIN(Code) | | Parameter value to allow anonymous users of gallery mode to be sent to
the gateway site as anonymous user (like the /portal URL) instead of
making them log in (like worksite, site, and tool URLs).
|
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 | protected 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.
|
destroy | public void destroy()(Code) | | Shutdown the servlet.
|
doDirectTool | protected void doDirectTool(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, String toolContextPath, String toolPathInfo) throws ToolException, IOException(Code) | | Do direct tool, takes the url, stored the destination and the target
iframe in the session constructs and outer url and when a request comes
in that matches the stored iframe it ejects the destination address
Parameters: req - Parameters: res - Parameters: session - Parameters: placementId - Parameters: toolContextPath - Parameters: toolPathInfo - Parameters: placementId - throws: ToolException - throws: IOException - |
doLogout | protected 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. |
getSiteEffectiveId | protected String getSiteEffectiveId(Site site)(Code) | | If this is a user site, return an id based on the user EID, otherwise
just return the site id.
Parameters: site - The site. The effective site id. |
getUserEidBasedSiteId | protected 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 |
indexOf | protected int indexOf(String value, List siteList)(Code) | | Find the site in the list that has this id - return the position.
Parameters: value - The site id to find. Parameters: siteList - The list of Site objects. The index position in siteList of the site with site id = value,or -1 if not found. |
redirectIfLoggedOut | protected 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(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)
|
|
|