Java Doc for CharonPortal.java in  » ERP-CRM-Financial » sakai » org » sakaiproject » portal » charon » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ERP CRM Financial » sakai » org.sakaiproject.portal.charon 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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  StringATTR_ERROR
     ThreadLocal attribute set while we are processing an error.
final protected static  StringATTR_SITE_PAGE
     Session attribute root for storing a site's last page visited - just append the site id.
final protected static  StringCONFIG_AUTO_RESET
    
final protected static  intERROR_GALLERY
    
final protected static  intERROR_SITE
     Error response modes.
final protected static  intERROR_WORKSITE
    
final protected static  StringPARAM_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  StringPARAM_SAKAI_SITE
    


Method Summary
protected  booleanallowTool(Site site, Placement placement)
    
protected  StringcalcSiteType(String siteId)
     Returns the type ("course", "project", "workspace", "mySpecialSiteType", etc) of the given site; special handling of returning "workspace" for user workspace sites.
public  voiddestroy()
     Shutdown the servlet.
protected  voiddoDirectTool(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, String toolContextPath, String toolPathInfo)
    
protected  voiddoError(HttpServletRequest req, HttpServletResponse res, Session session, int mode)
    
protected  voiddoErrorDone(HttpServletRequest req, HttpServletResponse res)
    
protected  voiddoErrorReport(HttpServletRequest req, HttpServletResponse res)
    
protected  voiddoGallery(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String pageId, String toolContextPath)
    
protected  voiddoGalleryTabs(HttpServletRequest req, HttpServletResponse res, Session session, String siteId)
    
protected  voiddoGet(HttpServletRequest req, HttpServletResponse res)
     Respond to navigation / access requests.
protected  voiddoHelp(HttpServletRequest req, HttpServletResponse res, Session session, String toolContextPath, String toolPathInfo)
    
protected  voiddoLogin(HttpServletRequest req, HttpServletResponse res, Session session, String returnPath, boolean skipContainer)
    
protected  voiddoLogout(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  voiddoNavLogin(HttpServletRequest req, HttpServletResponse res, Session session, String siteId)
    
protected  voiddoNavLoginGallery(HttpServletRequest req, HttpServletResponse res, Session session, String siteId)
    
protected  voiddoPage(HttpServletRequest req, HttpServletResponse res, Session session, String pageId, String toolContextPath)
    
protected  voiddoPost(HttpServletRequest req, HttpServletResponse res)
     Respond to data posting requests.
protected  voiddoPresence(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String toolContextPath, String toolPathInfo)
    
protected  voiddoSite(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String pageId, String toolContextPath)
    
protected  voiddoSiteTabs(HttpServletRequest req, HttpServletResponse res, Session session, String siteId)
    
protected  voiddoThrowableError(HttpServletRequest req, HttpServletResponse res, Throwable t)
    
protected  voiddoTitle(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  voiddoTool(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, String toolContextPath, String toolPathInfo)
    
protected  voiddoWorksite(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String pageId, String toolContextPath)
    
protected  voidendResponse(PrintWriter out)
    
protected  voidforwardPortal(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, ToolConfiguration p, String skin, String toolContextPath, String toolPathInfo)
    
protected  voidforwardTool(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, Placement p, String skin, String toolContextPath, String toolPathInfo)
    
protected  StringgetPlacement(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, boolean doPage)
    
protected  StringgetPortalPageUrl(ToolConfiguration p)
    
protected  StringgetScriptPath()
    
public  StringgetServletInfo()
     Access the Servlet's information display.
protected  StringgetSiteEffectiveId(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  SitegetSiteVisit(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  StringgetUserEidBasedSiteId(String userId)
    
protected  voidincludeBottom(PrintWriter out)
    
protected  voidincludeGalleryLogin(PrintWriter out, HttpServletRequest req, Session session, String siteId)
    
protected  voidincludeGalleryNav(PrintWriter out, HttpServletRequest req, Session session, String siteId)
    
protected  voidincludeLogin(PrintWriter out, HttpServletRequest req, Session session)
    
protected  voidincludeLogo(PrintWriter out, HttpServletRequest req, Session session, String siteId)
    
protected  voidincludePage(HttpServletRequest req, HttpServletResponse res, SitePage page, String toolContextPath, String wrapperClass)
    
protected  voidincludePageNav(HttpServletRequest req, HttpServletResponse res, Session session, Site site, SitePage page, String toolContextPath, String portalPrefix)
    
protected  voidincludeSiteNav(PrintWriter out, HttpServletRequest req, Session session, String siteId)
    
protected  voidincludeTabs(PrintWriter out, HttpServletRequest req, Session session, String siteId, String prefix, boolean addLogout)
    
protected  voidincludeTitle(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  voidincludeTool(HttpServletRequest req, HttpServletResponse res, ToolConfiguration placement)
    
protected  voidincludeWorksite(HttpServletRequest req, HttpServletResponse res, Session session, Site site, SitePage page, String toolContextPath, String portalPrefix)
    
protected  intindexOf(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  voidinit(ServletConfig config)
     Initialize the servlet.
protected  voidpostLogin(HttpServletRequest req, HttpServletResponse res, Session session, String loginPath)
    
protected  booleanredirectIfLoggedOut(HttpServletResponse res)
    
protected  voidsendPortalRedirect(HttpServletResponse res, String url)
     Send a redirect so our Portal window ends up at the url, via javascript.
protected  voidsetupForward(HttpServletRequest req, HttpServletResponse res, Placement p, String skin)
    
protected  voidshowSession(PrintWriter out, boolean html)
    
protected  PrintWriterstartResponse(HttpServletResponse res, String title, String skin, boolean top)
    

Field Detail
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





Method Detail
allowTool
protected boolean allowTool(Site site, Placement placement)(Code)



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 -



doError
protected void doError(HttpServletRequest req, HttpServletResponse res, Session session, int mode) throws ToolException, IOException(Code)



doErrorDone
protected void doErrorDone(HttpServletRequest req, HttpServletResponse res) throws ToolException, IOException(Code)



doErrorReport
protected void doErrorReport(HttpServletRequest req, HttpServletResponse res) throws ToolException, IOException(Code)



doGallery
protected void doGallery(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String pageId, String toolContextPath) throws ToolException, IOException(Code)



doGalleryTabs
protected void doGalleryTabs(HttpServletRequest req, HttpServletResponse res, Session session, String siteId) throws IOException(Code)



doGet
protected void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException(Code)
Respond to navigation / access requests.
Parameters:
  req - The servlet request.
Parameters:
  res - The servlet response.
throws:
  ServletException -
throws:
  IOException -



doHelp
protected void doHelp(HttpServletRequest req, HttpServletResponse res, Session session, String toolContextPath, String toolPathInfo) throws ToolException, IOException(Code)



doLogin
protected void doLogin(HttpServletRequest req, HttpServletResponse res, Session session, String returnPath, boolean skipContainer) throws ToolException(Code)



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 -



doNavLogin
protected void doNavLogin(HttpServletRequest req, HttpServletResponse res, Session session, String siteId) throws IOException(Code)



doNavLoginGallery
protected void doNavLoginGallery(HttpServletRequest req, HttpServletResponse res, Session session, String siteId) throws IOException(Code)



doPage
protected void doPage(HttpServletRequest req, HttpServletResponse res, Session session, String pageId, String toolContextPath) throws ToolException, IOException(Code)



doPost
protected void doPost(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException(Code)
Respond to data posting requests.
Parameters:
  req - The servlet request.
Parameters:
  res - The servlet response.
throws:
  ServletException -
throws:
  IOException -



doPresence
protected void doPresence(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String toolContextPath, String toolPathInfo) throws ToolException, IOException(Code)



doSite
protected void doSite(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String pageId, String toolContextPath) throws ToolException, IOException(Code)



doSiteTabs
protected void doSiteTabs(HttpServletRequest req, HttpServletResponse res, Session session, String siteId) throws IOException(Code)



doThrowableError
protected void doThrowableError(HttpServletRequest req, HttpServletResponse res, Throwable t)(Code)



doTitle
protected void doTitle(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, String toolContextPath, String toolPathInfo) throws ToolException, IOException(Code)
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. they can be removed for 2.5 - csev



doTool
protected void doTool(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, String toolContextPath, String toolPathInfo) throws ToolException, IOException(Code)



doWorksite
protected void doWorksite(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String pageId, String toolContextPath) throws ToolException, IOException(Code)



endResponse
protected void endResponse(PrintWriter out)(Code)



forwardPortal
protected void forwardPortal(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, ToolConfiguration p, String skin, String toolContextPath, String toolPathInfo) throws ToolException, IOException(Code)



forwardTool
protected void forwardTool(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, Placement p, String skin, String toolContextPath, String toolPathInfo) throws ToolException(Code)
Forward to the tool - but first setup JavaScript/CSS etc that the tool will render



getPlacement
protected String getPlacement(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, boolean doPage) throws ToolException(Code)



getPortalPageUrl
protected String getPortalPageUrl(ToolConfiguration p)(Code)



getScriptPath
protected String getScriptPath()(Code)



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.



getSiteVisit
protected Site getSiteVisit(String siteId) throws PermissionException, IdUnusedException(Code)
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. The Site.
throws:
  PermissionException - If not allowed.
throws:
  IdUnusedException - If not found.



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



includeBottom
protected void includeBottom(PrintWriter out)(Code)



includeGalleryLogin
protected void includeGalleryLogin(PrintWriter out, HttpServletRequest req, Session session, String siteId) throws IOException(Code)



includeGalleryNav
protected void includeGalleryNav(PrintWriter out, HttpServletRequest req, Session session, String siteId)(Code)



includeLogin
protected void includeLogin(PrintWriter out, HttpServletRequest req, Session session)(Code)



includeLogo
protected void includeLogo(PrintWriter out, HttpServletRequest req, Session session, String siteId) throws IOException(Code)



includePage
protected void includePage(HttpServletRequest req, HttpServletResponse res, SitePage page, String toolContextPath, String wrapperClass) throws IOException(Code)



includePageNav
protected void includePageNav(HttpServletRequest req, HttpServletResponse res, Session session, Site site, SitePage page, String toolContextPath, String portalPrefix) throws IOException(Code)



includeSiteNav
protected void includeSiteNav(PrintWriter out, HttpServletRequest req, Session session, String siteId)(Code)



includeTabs
protected void includeTabs(PrintWriter out, HttpServletRequest req, Session session, String siteId, String prefix, boolean addLogout) throws IOException(Code)



includeTitle
protected void includeTitle(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, ToolConfiguration placement, String skin, String toolContextPath, String toolPathInfo) throws IOException(Code)
Output the content of the title frame for a tool.



includeTool
protected void includeTool(HttpServletRequest req, HttpServletResponse res, ToolConfiguration placement) throws IOException(Code)



includeWorksite
protected void includeWorksite(HttpServletRequest req, HttpServletResponse res, Session session, Site site, SitePage page, String toolContextPath, String portalPrefix) throws IOException(Code)



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.



init
public void init(ServletConfig config) throws ServletException(Code)
Initialize the servlet.
Parameters:
  config - The servlet config.
throws:
  ServletException -



postLogin
protected void postLogin(HttpServletRequest req, HttpServletResponse res, Session session, String loginPath) throws ToolException(Code)
Send the POST request to login
Parameters:
  req -
Parameters:
  res -
Parameters:
  session -
throws:
  IOException -



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



setupForward
protected void setupForward(HttpServletRequest req, HttpServletResponse res, Placement p, String skin) throws ToolException(Code)



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.



startResponse
protected PrintWriter startResponse(HttpServletResponse res, String title, String skin, boolean top) throws IOException(Code)



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)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.