| org.apache.jetspeed.page.PageManager
All known Subclasses: org.apache.jetspeed.page.psml.CastorXmlPageManager, org.apache.jetspeed.page.impl.DatabasePageManager, org.apache.jetspeed.page.AbstractPageManager,
| PageManager | | public interface PageManager (Code) | | This service is responsible for loading and saving Pages into
the selected persistent store.
version:
$Id: PageManager.java 516448 2007-03-09 16:25:47Z ate $ |
| Method Summary | |
| public void | addListener(PageManagerEventListener listener)
| | public int | addPages(Page[] pages)
| | public boolean | checkConstraint(String securityConstraintName, String actions)
| | public Folder | copyFolder(Folder source, String path)
| | public Fragment | copyFragment(Fragment source, String name)
| | public Link | copyLink(Link source, String path)
| | public Page | copyPage(Page source, String path)
| | public PageSecurity | copyPageSecurity(PageSecurity source)
Copy the source page security (both global constraints and constraint references)
creating and returning a new copy of the page security definition. | | public void | createUserHomePagesFromRoles(Subject subject)
Creates a user's home page from the roles of the current user.
The use case: when a portal is setup to use shared pages, but then
the user attempts to customize. | | public void | deepCopyFolder(Folder srcFolder, String destinationPath, String owner)
Deep copy a folder. | | public boolean | folderExists(String folderName)
| | public NodeSet | getAll(Folder folder)
getAll
Locates folders and documents within a specified parent folder.
Returned folders and documents are filtered according to
security constraints and/or permissions.
See Also: org.apache.jetspeed.om.folder.Folder.getAll(org.apache.jetspeed.om.folder.Folder)
Parameters:
folder - The parent folder. | | public boolean | getConstraintsEnabled()
| | public ContentPage | getContentPage(String path)
| | public Folder | getFolder(String folderPath)
getFolder
Locates a folder for the given path. | | public Folder | getFolder(Folder folder, String name)
getFolder
Locates folders within a specified parent folder.
Returned documents are filtered according to security
constraints and/or permissions.
See Also: org.apache.jetspeed.om.folder.Folder.getFolder(org.apache.jetspeed.om.folder.Folderjava.lang.String)
Parameters:
folder - The parent folder.
Parameters:
name - The name of folder to retrieve. | | public NodeSet | getFolders(Folder folder)
getFolders
Locates folders within a specified parent folder.
Returned documents are filtered according to security
constraints and/or permissions.
See Also: org.apache.jetspeed.om.folder.Folder.getFolders(org.apache.jetspeed.om.folder.Folder)
Parameters:
folder - The parent folder. | | public Link | getLink(String name)
| | public Link | getLink(Folder folder, String name)
getLink
Locates documents within a specified parent folder.
Returned documents are filtered according to security
constraints and/or permissions.
See Also: org.apache.jetspeed.om.folder.Folder.getLink(org.apache.jetspeed.om.folder.Folderjava.lang.String)
Parameters:
folder - The parent folder.
Parameters:
name - The name of page to retrieve. | | public NodeSet | getLinks(Folder folder)
getLinks
See Also: org.apache.jetspeed.om.folder.Folder.getLinks(org.apache.jetspeed.om.folder.Folder)
See Also: Locates documents within a specified parent folder.
See Also: Returned documents are filtered according to security
See Also: constraints and/or permissions.
Parameters:
folder - The parent folder. | | public Page | getPage(String path)
| | public Page | getPage(Folder folder, String name)
getPage
Locates documents within a specified parent folder.
Returned documents are filtered according to security
constraints and/or permissions.
See Also: org.apache.jetspeed.om.folder.Folder.getPage(org.apache.jetspeed.om.folder.Folderjava.lang.String)
Parameters:
folder - The parent folder.
Parameters:
name - The name of page to retrieve. | | public PageSecurity | getPageSecurity()
| | public PageSecurity | getPageSecurity(Folder folder)
getPageSecurity
Locates documents within a specified parent folder.
Returned documents are filtered according to security
constraints and/or permissions.
See Also: org.apache.jetspeed.om.folder.Folder.getPageSecurity(org.apache.jetspeed.om.folder.Folder)
Parameters:
folder - The parent folder. | | public NodeSet | getPages(Folder folder)
getPages
Locates documents within a specified parent folder.
Returned documents are filtered according to security
constraints and/or permissions.
See Also: org.apache.jetspeed.om.folder.Folder.getPages(org.apache.jetspeed.om.folder.Folder)
Parameters:
folder - The parent folder. | | public boolean | getPermissionsEnabled()
| | public Folder | getUserFolder(String userName)
| | public Page | getUserPage(String userName, String pageName)
| | public boolean | linkExists(String linkName)
| | public Folder | newFolder(String path)
| | public MenuDefinition | newFolderMenuDefinition()
| | public MenuExcludeDefinition | newFolderMenuExcludeDefinition()
| | public MenuIncludeDefinition | newFolderMenuIncludeDefinition()
| | public MenuOptionsDefinition | newFolderMenuOptionsDefinition()
| | public MenuSeparatorDefinition | newFolderMenuSeparatorDefinition()
| | public SecurityConstraint | newFolderSecurityConstraint()
| | public Fragment | newFragment()
| | public FragmentPreference | newFragmentPreference()
| | public SecurityConstraint | newFragmentSecurityConstraint()
| | public Link | newLink(String path)
| | public SecurityConstraint | newLinkSecurityConstraint()
| | public Page | newPage(String path)
| | public MenuDefinition | newPageMenuDefinition()
| | public MenuExcludeDefinition | newPageMenuExcludeDefinition()
| | public MenuIncludeDefinition | newPageMenuIncludeDefinition()
| | public MenuOptionsDefinition | newPageMenuOptionsDefinition()
| | public MenuSeparatorDefinition | newPageMenuSeparatorDefinition()
| | public PageSecurity | newPageSecurity()
| | public SecurityConstraint | newPageSecurityConstraint()
| | public SecurityConstraint | newPageSecuritySecurityConstraint()
| | public Fragment | newPortletFragment()
| | public SecurityConstraints | newSecurityConstraints()
| | public SecurityConstraintsDef | newSecurityConstraintsDef()
| | public boolean | pageExists(String pageName)
| | public void | removeFolder(Folder folder)
Remove a folder. | | public void | removeLink(Link link)
Remove a link. | | public void | removeListener(PageManagerEventListener listener)
| | public void | removePage(Page page)
Remove a document. | | public void | removePageSecurity(PageSecurity pageSecurity)
Remove a page security document. | | public void | reset()
| | public void | updateFolder(Folder folder)
| | public void | updateFolder(Folder folder, boolean deep)
| | public void | updateLink(Link link)
| | public void | updatePage(Page page)
| | public void | updatePageSecurity(PageSecurity pageSecurity)
| | public boolean | userFolderExists(String userName)
| | public boolean | userPageExists(String userName, String pageName)
|
| SERVICE_NAME | | public String SERVICE_NAME(Code) | | The name of the service
|
| addListener | | public void addListener(PageManagerEventListener listener)(Code) | | addListener - add page manager event listener
Parameters:
listener - page manager event listener |
| checkConstraint | | public boolean checkConstraint(String securityConstraintName, String actions)(Code) | | For a given security constraint definition name, and the given action(s),
make a constraint check for the current user subject
Parameters:
securityConstraintName - the name of the security constraint definition
Parameters:
actions - one or more portlet actions (view,edit,help,..) |
| copyFolder | | public Folder copyFolder(Folder source, String path) throws NodeException(Code) | | Copy the source folder creating and returning a new copy of the folder
with the same content as the source
All subobjects are created with new ids
Parameters:
source - The source Folder object to be copied
Parameters:
path - a PSML normalized path to the new folder to be created a new Folder object copied from the source, with new subobject ids |
| copyFragment | | public Fragment copyFragment(Fragment source, String name) throws NodeException(Code) | | Copy the source fragment creating and returning a new copy of the fragment
with the parameter collection as the source
The fragment is created with a new fragment id
Parameters:
source - The source Fragment object to be copied
Parameters:
the - new fragment name, can be the same as source fragment name a new Fragment object copied from the source |
| copyLink | | public Link copyLink(Link source, String path) throws NodeException(Code) | | Copy the source link creating and returning a new copy of the link
Parameters:
source - The source Link object to be copied
Parameters:
path - a PSML normalized path to the new link to be created a new Link object copied from the source |
| copyPage | | public Page copyPage(Page source, String path) throws NodeException(Code) | | Copy the source page creating and returning a new copy of the page
with the same portlet and fragment collection as the source
All fragments are created with new fragment ids
Parameters:
source - The source Page object to be copied
Parameters:
path - a PSML normalized path to the new page to be created a new Page object copied from the source, with new fragment ids |
| copyPageSecurity | | public PageSecurity copyPageSecurity(PageSecurity source) throws NodeException(Code) | | Copy the source page security (both global constraints and constraint references)
creating and returning a new copy of the page security definition.
Parameters:
source - The source PageSecurity definitions the new page security object
throws:
NodeException - |
| createUserHomePagesFromRoles | | public void createUserHomePagesFromRoles(Subject subject) throws NodeException(Code) | | Creates a user's home page from the roles of the current user.
The use case: when a portal is setup to use shared pages, but then
the user attempts to customize. At this point, we create the new page(s) for the user.
Parameters:
subject - The full user Java Security subject. |
| deepCopyFolder | | public void deepCopyFolder(Folder srcFolder, String destinationPath, String owner) throws NodeException(Code) | | Deep copy a folder. Copies a folder and all subcontents including
other folders, subpages, links, menus, security, fragments.
Parameters:
source - source folder
Parameters:
dest - destination folder
Parameters:
owner - set owner of the new folder(s), or null for no owner |
| folderExists | | public boolean folderExists(String folderName)(Code) | | Check if a folder exists for the given folder name
Parameters:
folderName - |
| getConstraintsEnabled | | public boolean getConstraintsEnabled()(Code) | |
getConstraintsEnabled
enabled indicator |
| getPermissionsEnabled | | public boolean getPermissionsEnabled()(Code) | |
getPermissionsEnabled
enabled indicator |
| linkExists | | public boolean linkExists(String linkName)(Code) | | Check if a link exists for the given link name
Parameters:
linkName - |
| newFolder | | public Folder newFolder(String path)(Code) | | Create a new empty Folder instance
a newly created Folder object |
| newFolderMenuDefinition | | public MenuDefinition newFolderMenuDefinition()(Code) | | newFolderMenuDefinition - creates a new empty menu definition
a newly created MenuDefinition object to be used in Folder |
| newFolderMenuExcludeDefinition | | public MenuExcludeDefinition newFolderMenuExcludeDefinition()(Code) | | newFolderMenuExcludeDefinition - creates a new empty menu exclude definition
a newly created MenuExcludeDefinition object to be used in Folder |
| newFolderMenuIncludeDefinition | | public MenuIncludeDefinition newFolderMenuIncludeDefinition()(Code) | | newFolderMenuIncludeDefinition - creates a new empty menu include definition
a newly created MenuIncludeDefinition object to be used in Folder |
| newFolderMenuOptionsDefinition | | public MenuOptionsDefinition newFolderMenuOptionsDefinition()(Code) | | newFolderMenuOptionsDefinition - creates a new empty menu options definition
a newly created MenuOptionsDefinition object to be used in Folder |
| newFolderMenuSeparatorDefinition | | public MenuSeparatorDefinition newFolderMenuSeparatorDefinition()(Code) | | newFolderMenuSeparatorDefinition - creates a new empty menu separator definition
a newly created MenuSeparatorDefinition object to be used in Folder |
| newFolderSecurityConstraint | | public SecurityConstraint newFolderSecurityConstraint()(Code) | | newFolderSecurityConstraint - creates a new security constraint definition
a newly created SecurityConstraint object to be used in Folder |
| newFragment | | public Fragment newFragment()(Code) | | Creates a new empty Layout Fragment instance
a newly created Fragment object |
| newFragmentPreference | | public FragmentPreference newFragmentPreference()(Code) | | newFragmentPreference - creates a new fragment preference
a newly created FragmentPreference |
| newFragmentSecurityConstraint | | public SecurityConstraint newFragmentSecurityConstraint()(Code) | | newFragmentSecurityConstraint - creates a new security constraint definition
a newly created SecurityConstraint object to be used in Fragment |
| newLink | | public Link newLink(String path)(Code) | | Creates a new empty Link instance
a newly created Link object |
| newLinkSecurityConstraint | | public SecurityConstraint newLinkSecurityConstraint()(Code) | | newLinkSecurityConstraint - creates a new security constraint definition
a newly created SecurityConstraint object to be used in Link |
| newPage | | public Page newPage(String path)(Code) | | Creates a new empty Page instance
a newly created Page object |
| newPageMenuDefinition | | public MenuDefinition newPageMenuDefinition()(Code) | | newPageMenuDefinition - creates a new empty menu definition
a newly created MenuDefinition object to be used in Page |
| newPageMenuExcludeDefinition | | public MenuExcludeDefinition newPageMenuExcludeDefinition()(Code) | | newPageMenuExcludeDefinition - creates a new empty menu exclude definition
a newly created MenuExcludeDefinition object to be used in Page |
| newPageMenuIncludeDefinition | | public MenuIncludeDefinition newPageMenuIncludeDefinition()(Code) | | newPageMenuIncludeDefinition - creates a new empty menu include definition
a newly created MenuIncludeDefinition object to be used in Page |
| newPageMenuOptionsDefinition | | public MenuOptionsDefinition newPageMenuOptionsDefinition()(Code) | | newPageMenuOptionsDefinition - creates a new empty menu options definition
a newly created MenuOptionsDefinition object to be used in Page |
| newPageMenuSeparatorDefinition | | public MenuSeparatorDefinition newPageMenuSeparatorDefinition()(Code) | | newPageMenuSeparatorDefinition - creates a new empty menu separator definition
a newly created MenuSeparatorDefinition object to be used in Page |
| newPageSecurity | | public PageSecurity newPageSecurity()(Code) | | Creates a new empty PageSecurity instance
a newly created PageSecurity object |
| newPageSecurityConstraint | | public SecurityConstraint newPageSecurityConstraint()(Code) | | newPageSecurityConstraint - creates a new security constraint definition
a newly created SecurityConstraint object to be used in Page |
| newPageSecuritySecurityConstraint | | public SecurityConstraint newPageSecuritySecurityConstraint()(Code) | | newPageSecuritySecurityConstraint - creates a new security constraint definition
a newly created SecurityConstraint object to be used in PageSecurity |
| newPortletFragment | | public Fragment newPortletFragment()(Code) | | Creates a new empty Portlet Fragment instance
a newly created Fragment object |
| newSecurityConstraints | | public SecurityConstraints newSecurityConstraints()(Code) | | newSecurityConstraints - creates a new empty security constraints definition
a newly created SecurityConstraints object |
| newSecurityConstraintsDef | | public SecurityConstraintsDef newSecurityConstraintsDef()(Code) | | newSecurityConstraintsDef - creates a new security constraints definition
a newly created SecurityConstraintsDef object |
| pageExists | | public boolean pageExists(String pageName)(Code) | | Check if a page exists for the given page name
Parameters:
pageName - |
| removeListener | | public void removeListener(PageManagerEventListener listener)(Code) | | removeListener - remove page manager event listener
Parameters:
listener - page manager event listener |
| reset | | public void reset()(Code) | | reset - force subsequent refresh from persistent store
|
| updateFolder | | public void updateFolder(Folder folder, boolean deep) throws NodeException, FolderNotUpdatedException(Code) | | Update a folder in persistent storage
Parameters:
folder - The folder to be updated.
Parameters:
deep - Flag to control recursive deep updates. |
| userFolderExists | | public boolean userFolderExists(String userName)(Code) | | Check if the root folder exists for a given user
Parameters:
userName - |
| userPageExists | | public boolean userPageExists(String userName, String pageName)(Code) | | Check if a page exists for the given user
Parameters:
userName -
Parameters:
pageName - |
|
|