| org.sakaiproject.portal.api.Portal
All known Subclasses: org.sakaiproject.portal.charon.SkinnableCharonPortal,
| Portal | | public interface Portal (Code) | | This interface represents a portal and is used mainly by portal handlers that
will not know the details of the portal implimentation.
author:
ieb
since:
Sakai 2.4
version:
$Rev: 29143 $ |
| Method Summary | |
| String | calcSiteType(String siteId)
work out the type of the site based on the site id. | | Map | convertSiteToMap(HttpServletRequest req, Site s, String prefix, String currentSiteId, String myWorkspaceSiteId, boolean includeSummary, boolean expandSite, boolean resetTools, boolean doPages, String toolContextPath, boolean loggedIn)
| | 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)
| | void | doError(HttpServletRequest req, HttpServletResponse res, Session session, int mode)
| | void | doLogin(HttpServletRequest req, HttpServletResponse res, Session session, String returnPath, boolean skipContainer)
| | 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. | | void | forwardPortal(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, ToolConfiguration siteTool, String skin, String toolContextPath, String toolPathInfo)
| | void | forwardTool(ActiveTool tool, HttpServletRequest req, HttpServletResponse res, Placement placement, String skin, String toolContextPath, String toolPathInfo)
| | String | getPlacement(HttpServletRequest req, HttpServletResponse res, Session session, String placementId, boolean doPage)
| | String | getPortalContext()
Get the context name of the portal. | | String | getPortalPageUrl(ToolConfiguration siteTool)
| | ServletContext | getServletContext()
| | String | getUserEidBasedSiteId(String userId)
| | void | includeBottom(PortalRenderContext rcontext)
include the model section that relates to the bottom of the page. | | void | includeLogin(PortalRenderContext rcontext, HttpServletRequest req, Session session)
| | PortalRenderContext | includePortal(HttpServletRequest req, HttpServletResponse res, Session session, String siteId, String toolId, String toolContextPath, String prefix, boolean doPages, boolean resetTools, boolean includeSummary, boolean expandSite)
| | Map | includeTool(HttpServletResponse res, HttpServletRequest req, ToolConfiguration placement)
| | boolean | redirectIfLoggedOut(HttpServletResponse res)
| | void | sendResponse(PortalRenderContext rcontext, HttpServletResponse res, String template, String contentType)
| | void | setupForward(HttpServletRequest req, HttpServletResponse res, Placement p, String skin)
| | PortalRenderContext | startPageContext(String siteType, String title, String skin, HttpServletRequest request)
|
| ATTR_ERROR | | final public static String ATTR_ERROR(Code) | | ThreadLocal attribute set while we are processing an error.
|
| ATTR_SITE_PAGE | | final public 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 public static String CONFIG_AUTO_RESET(Code) | | Configuration option to enable/disable state reset on navigation change
|
| DEFAULT_PORTAL_CONTEXT | | final public static String DEFAULT_PORTAL_CONTEXT(Code) | | The default portal name is none is specified.
|
| ERROR_GALLERY | | final public static int ERROR_GALLERY(Code) | | |
| ERROR_SITE | | final public static int ERROR_SITE(Code) | | Error response modes.
|
| ERROR_WORKSITE | | final public static int ERROR_WORKSITE(Code) | | |
| PARAM_FORCE_LOGIN | | final public 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_FORCE_LOGOUT | | final public static String PARAM_FORCE_LOGOUT(Code) | | |
| TOOLCONFIG_HELP_DOCUMENT_ID | | final public static String TOOLCONFIG_HELP_DOCUMENT_ID(Code) | | |
| TOOLCONFIG_HELP_DOCUMENT_URL | | final public static String TOOLCONFIG_HELP_DOCUMENT_URL(Code) | | |
| TOOLCONFIG_SHOW_HELP_BUTTON | | final public static String TOOLCONFIG_SHOW_HELP_BUTTON(Code) | | |
| TOOLCONFIG_SHOW_RESET_BUTTON | | final public static String TOOLCONFIG_SHOW_RESET_BUTTON(Code) | | Names of tool config/registration attributes that control the rendering
of the tool's titlebar
|
| calcSiteType | | String calcSiteType(String siteId)(Code) | | work out the type of the site based on the site id.
Parameters:
siteId - |
| convertSiteToMap | | 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) | | convert a single site into a map
Parameters:
req -
Parameters:
s -
Parameters:
prefix -
Parameters:
currentSiteId -
Parameters:
myWorkspaceSiteId -
Parameters:
includeSummary -
Parameters:
expandSite -
Parameters:
resetTools -
Parameters:
doPages -
Parameters:
toolContextPath -
Parameters:
loggedIn - |
| convertSitesToMaps | | 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) | | convert sites into a map for the view tree
Parameters:
req -
Parameters:
mySites -
Parameters:
prefix -
Parameters:
currentSiteId -
Parameters:
myWorkspaceSiteId -
Parameters:
includeSummary -
Parameters:
expandSite -
Parameters:
resetTools -
Parameters:
doPages -
Parameters:
toolContextPath -
Parameters:
loggedIn - |
| doLogout | | 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:
ToolException - |
| getPortalContext | | String getPortalContext()(Code) | | Get the context name of the portal. This is the name used to identify the
portal implimentation in the portal service and to other parts of the
system. Typically portals will be registered with the portal service
using a name and render engines and PortalHandlers will connect to named
portals.
|
| getPortalPageUrl | | String getPortalPageUrl(ToolConfiguration siteTool)(Code) | | get the portal page URL base on the tool supplied
Parameters:
siteTool - |
| getServletContext | | ServletContext getServletContext()(Code) | | Get the servlet context associated with the portal
|
| getUserEidBasedSiteId | | String getUserEidBasedSiteId(String userId)(Code) | | get the site id for the user
Parameters:
userId - |
| includeBottom | | void includeBottom(PortalRenderContext rcontext)(Code) | | include the model section that relates to the bottom of the page.
Parameters:
rcontext - |
| includePortal | | 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) | | populate the view tree for the model
Parameters:
req -
Parameters:
res -
Parameters:
session -
Parameters:
siteId -
Parameters:
toolId -
Parameters:
toolContextPath -
Parameters:
prefix -
Parameters:
doPages -
Parameters:
resetTools -
Parameters:
includeSummary -
Parameters:
expandSite -
throws:
ToolException -
throws:
IOException - |
|
|