|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.portalsite.impl.PortalSiteRequestContextImpl
public class PortalSiteRequestContextImpl
This class encapsulates managed request state for and interface to the portal-site component.
Constructor Summary | |
---|---|
PortalSiteRequestContextImpl(PortalSiteSessionContextImpl sessionContext,
java.util.Map requestProfileLocators)
PortalSiteRequestContextImpl - constructor |
|
PortalSiteRequestContextImpl(PortalSiteSessionContextImpl sessionContext,
java.util.Map requestProfileLocators,
boolean requestFallback)
PortalSiteRequestContextImpl - constructor |
|
PortalSiteRequestContextImpl(PortalSiteSessionContextImpl sessionContext,
java.util.Map requestProfileLocators,
boolean requestFallback,
boolean useHistory)
PortalSiteRequestContextImpl - constructor |
Method Summary | |
---|---|
java.util.Set |
getCustomMenuNames()
getCustomMenuNames - get set of custom menu names available as defined for the request profiled page and folder |
Folder |
getFolder()
getFolder - get folder proxy relative to request profiled page |
java.util.Map |
getLocators()
getLocators - get profile locators by locator names |
Page |
getManagedPage()
getManagedPage - get request profiled concrete page instance as managed by the page manager |
Menu |
getMenu(java.lang.String name)
getMenu - get instantiated menu available for the request profiled page and folder |
Menu |
getMenu(java.lang.String name,
java.util.Set names)
getMenu - get instantiated menu available for the request profiled page and folder, avoiding cyclic menu definition loops by propagating related menu names set from menu construction |
Page |
getPage()
getPage - get request profiled page proxy |
Folder |
getParentFolder()
getParentFolder - get parent folder proxy relative to request profiled page |
Folder |
getRootFolder()
getRootFolder - get root profiled folder proxy |
NodeSet |
getRootLinks()
getRootLinks - get node set of link proxies relative to profiled root folder |
PortalSiteSessionContext |
getSessionContext()
getSessionContext - get component session context |
NodeSet |
getSiblingFolders()
getSiblingFolders - get node set of sibling folder proxies relative to request profiled page, (includes profiled page folder proxy) |
NodeSet |
getSiblingPages()
getSiblingPages - get node set of sibling page proxies relative to request profiled page, (includes profiled page proxy) |
java.util.Set |
getStandardMenuNames()
getStandardMenuNames - get set of available standard menu names |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PortalSiteRequestContextImpl(PortalSiteSessionContextImpl sessionContext, java.util.Map requestProfileLocators, boolean requestFallback, boolean useHistory)
sessionContext
- session contextrequestProfileLocators
- request profile locatorsrequestFallback
- flag specifying whether to fallback to root folder
if locators do not select a page or access is forbiddenuseHistory
- flag indicating whether to use visited page
history to select default page per site folderpublic PortalSiteRequestContextImpl(PortalSiteSessionContextImpl sessionContext, java.util.Map requestProfileLocators, boolean requestFallback)
sessionContext
- session contextrequestProfileLocators
- request profile locatorsrequestFallback
- flag specifying whether to fallback to root folder
if locators do not select a page or access is forbiddenpublic PortalSiteRequestContextImpl(PortalSiteSessionContextImpl sessionContext, java.util.Map requestProfileLocators)
sessionContext
- session contextrequestProfileLocators
- request profile locatorsMethod Detail |
---|
public PortalSiteSessionContext getSessionContext()
getSessionContext
in interface PortalSiteRequestContext
public java.util.Map getLocators()
getLocators
in interface PortalSiteRequestContext
public Page getManagedPage() throws NodeNotFoundException
getManagedPage
in interface PortalSiteRequestContext
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not grantedpublic Page getPage() throws NodeNotFoundException
getPage
in interface PortalSiteRequestContext
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not grantedpublic Folder getFolder() throws NodeNotFoundException
getFolder
in interface PortalSiteRequestContext
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not grantedpublic NodeSet getSiblingPages() throws NodeNotFoundException
getSiblingPages
in interface PortalSiteRequestContext
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not grantedpublic Folder getParentFolder() throws NodeNotFoundException
getParentFolder
in interface PortalSiteRequestContext
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not grantedpublic NodeSet getSiblingFolders() throws NodeNotFoundException
getSiblingFolders
in interface PortalSiteRequestContext
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not grantedpublic Folder getRootFolder() throws NodeNotFoundException
getRootFolder
in interface PortalSiteRequestContext
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not grantedpublic NodeSet getRootLinks() throws NodeNotFoundException
getRootLinks
in interface PortalSiteRequestContext
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not grantedpublic java.util.Set getStandardMenuNames()
getStandardMenuNames
in interface PortalSiteRequestContext
public java.util.Set getCustomMenuNames() throws NodeNotFoundException
getCustomMenuNames
in interface PortalSiteRequestContext
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not grantedpublic Menu getMenu(java.lang.String name) throws NodeNotFoundException
getMenu
in interface PortalSiteRequestContext
name
- menu definition name
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not grantedpublic Menu getMenu(java.lang.String name, java.util.Set names) throws NodeNotFoundException
name
- menu definition namenames
- set of related menu definition names
NodeNotFoundException
- if page not found
java.lang.SecurityException
- if page view access not granted
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |