org.apache.jetspeed.page.impl
Class CastorXmlPageManager

java.lang.Object
  org.apache.jetspeed.page.impl.AbstractPageManager
      org.apache.jetspeed.page.impl.CastorXmlPageManager

All Implemented Interfaces:

org.apache.jetspeed.cache.file.FileCacheEventListener, org.apache.jetspeed.page.PageManager

public class CastorXmlPageManager

extends AbstractPageManager

implements org.apache.jetspeed.page.PageManager, org.apache.jetspeed.cache.file.FileCacheEventListener

This service is responsible for loading and saving PSML pages serialized to disk

Version:

$Id: CastorXmlPageManager.java 219579 2005-07-18 22:26:44Z taylor $

Author:

Rapha???l Luta , Scott T Weaver

Field Summary

private org.apache.jetspeed.cache.file.FileCache	fileCache
private org.apache.jetspeed.page.document.FolderHandler	folderHandler
private org.apache.jetspeed.page.document.DocumentHandlerFactory	handlerFactory
private static org.apache.commons.logging.Log	log
protected static String	PROFILE_NAVIGATION_PROPERTY_FOLDER_PREFIX
protected static String	PROFILE_PROPERTY_FOLDER_PREFIX

Fields inherited from class org.apache.jetspeed.page.impl.AbstractPageManager

folderClass, fragmentClass, generator, linkClass, menuDefinitionClass, menuExcludeDefinitionClass, menuIncludeDefinitionClass, menuOptionsDefinitionClass, menuSeparatorDefinitionClass, pageClass, propertyClass, securityConstraintClass, securityConstraintsClass

Fields inherited from interface org.apache.jetspeed.page.PageManager

SERVICE_NAME

Constructor Summary

CastorXmlPageManager(org.apache.jetspeed.idgenerator.IdGenerator generator, org.apache.jetspeed.page.document.DocumentHandlerFactory handlerFactory, org.apache.jetspeed.page.document.FolderHandler folderHandler, org.apache.jetspeed.cache.file.FileCache fileCache, boolean permissionsEnabled, boolean constraintsEnabled)

CastorXmlPageManager(org.apache.jetspeed.idgenerator.IdGenerator generator, org.apache.jetspeed.page.document.DocumentHandlerFactory handlerFactory, org.apache.jetspeed.page.document.FolderHandler folderHandler, org.apache.jetspeed.cache.file.FileCache fileCache, boolean permissionsEnabled, boolean constraintsEnabled, List modelClasses)

Method Summary

void	evict(org.apache.jetspeed.cache.file.FileCacheEntry entry) evict file cache entry
org.apache.jetspeed.om.page.ContentPage	getContentPage(String path)
org.apache.jetspeed.om.folder.Folder	getFolder(String folderPath) getFolder
org.apache.jetspeed.om.page.Link	getLink(String path) getLink
private FolderImpl	getNodeFolder(String nodePath) getNodeFolder - get folder implementation associated with specifed path
private String	getNodeName(String nodePath) getNodeFolder - get name of node from specified path
org.apache.jetspeed.om.page.Page	getPage(String path) getPage
org.apache.jetspeed.om.page.PageSecurity	getPageSecurity() getPageSecurity
void	refresh(org.apache.jetspeed.cache.file.FileCacheEntry entry) refresh file cache entry
void	removeFolder(org.apache.jetspeed.om.folder.Folder folder) removeFolder
void	removeLink(org.apache.jetspeed.om.page.Link link) removeLink
void	removePage(org.apache.jetspeed.om.page.Page page) removePage
void	updateFolder(org.apache.jetspeed.om.folder.Folder folder) updateFolder
void	updateLink(org.apache.jetspeed.om.page.Link link) updateLink
void	updatePage(org.apache.jetspeed.om.page.Page page) updatePage

Methods inherited from class org.apache.jetspeed.page.impl.AbstractPageManager

addListener, cloneFragment, cloneMenuDefinitions, cloneMenuElements, clonePage, cloneSecurityConstraints, getConstraintsEnabled, getPermissionsEnabled, newFolder, newFragment, newLink, newMenuDefinition, newMenuExcludeDefinition, newMenuIncludeDefinition, newMenuOptionsDefinition, newMenuSeparatorDefinition, newPage, newProperty, newSecurityConstraint, newSecurityConstraints, notifyNewNode, notifyRemovedNode, notifyUpdatedNode, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jetspeed.page.PageManager

addListener, clonePage, getConstraintsEnabled, getPermissionsEnabled, newFolder, newFragment, newLink, newMenuDefinition, newMenuExcludeDefinition, newMenuIncludeDefinition, newMenuOptionsDefinition, newMenuSeparatorDefinition, newPage, newProperty, newSecurityConstraint, newSecurityConstraints, removeListener

Field Detail

log

private static final org.apache.commons.logging.Log log

PROFILE_PROPERTY_FOLDER_PREFIX

protected static final String PROFILE_PROPERTY_FOLDER_PREFIX

See Also:

Constant Field Values

PROFILE_NAVIGATION_PROPERTY_FOLDER_PREFIX

protected static final String PROFILE_NAVIGATION_PROPERTY_FOLDER_PREFIX

See Also:

Constant Field Values

handlerFactory

private org.apache.jetspeed.page.document.DocumentHandlerFactory handlerFactory

folderHandler

private org.apache.jetspeed.page.document.FolderHandler folderHandler

fileCache

private org.apache.jetspeed.cache.file.FileCache fileCache

Constructor Detail

CastorXmlPageManager

public CastorXmlPageManager(org.apache.jetspeed.idgenerator.IdGenerator generator,
                            org.apache.jetspeed.page.document.DocumentHandlerFactory handlerFactory,
                            org.apache.jetspeed.page.document.FolderHandler folderHandler,
                            org.apache.jetspeed.cache.file.FileCache fileCache,
                            boolean permissionsEnabled,
                            boolean constraintsEnabled)
                     throws FileNotFoundException

CastorXmlPageManager

public CastorXmlPageManager(org.apache.jetspeed.idgenerator.IdGenerator generator,
                            org.apache.jetspeed.page.document.DocumentHandlerFactory handlerFactory,
                            org.apache.jetspeed.page.document.FolderHandler folderHandler,
                            org.apache.jetspeed.cache.file.FileCache fileCache,
                            boolean permissionsEnabled,
                            boolean constraintsEnabled,
                            List modelClasses)
                     throws FileNotFoundException

Method Detail

getPage

public org.apache.jetspeed.om.page.Page getPage(String path)
                                         throws org.apache.jetspeed.page.PageNotFoundException,
                                                org.apache.jetspeed.om.folder.FolderNotFoundException,
                                                org.apache.jetspeed.page.document.NodeException

getPage

Specified by:

getPage in interface org.apache.jetspeed.page.PageManager

Parameters:

path -

Returns:

page

Throws:

org.apache.jetspeed.page.PageNotFoundException

org.apache.jetspeed.page.document.NodeException

org.apache.jetspeed.om.folder.FolderNotFoundException

See Also:

PageManager.getPage(java.lang.String)

updatePage

public void updatePage(org.apache.jetspeed.om.page.Page page)
                throws org.apache.jetspeed.exception.JetspeedException

updatePage

Specified by:

updatePage in interface org.apache.jetspeed.page.PageManager

Throws:

org.apache.jetspeed.exception.JetspeedException

See Also:

org.apache.jetspeed.services.page.PageManagerService#updatePage(org.apache.jetspeed.om.page.Page)

removePage

public void removePage(org.apache.jetspeed.om.page.Page page)
                throws org.apache.jetspeed.exception.JetspeedException

removePage

Specified by:

removePage in interface org.apache.jetspeed.page.PageManager

Throws:

org.apache.jetspeed.exception.JetspeedException

See Also:

org.apache.jetspeed.services.page.PageManagerService#removePage(org.apache.jetspeed.om.page.Page)

getLink

public org.apache.jetspeed.om.page.Link getLink(String path)
                                         throws org.apache.jetspeed.page.document.DocumentNotFoundException,
                                                org.apache.jetspeed.page.document.UnsupportedDocumentTypeException,
                                                org.apache.jetspeed.om.folder.FolderNotFoundException,
                                                org.apache.jetspeed.page.document.NodeException

getLink

Specified by:

getLink in interface org.apache.jetspeed.page.PageManager

Parameters:

path -

Returns:

link

Throws:

org.apache.jetspeed.page.document.DocumentNotFoundException

org.apache.jetspeed.page.document.UnsupportedDocumentTypeException

org.apache.jetspeed.page.document.NodeException

org.apache.jetspeed.om.folder.FolderNotFoundException

See Also:

PageManager.getLink(java.lang.String)

updateLink

public void updateLink(org.apache.jetspeed.om.page.Link link)
                throws org.apache.jetspeed.exception.JetspeedException

updateLink

Specified by:

updateLink in interface org.apache.jetspeed.page.PageManager

Throws:

org.apache.jetspeed.exception.JetspeedException

See Also:

org.apache.jetspeed.services.page.PageManagerService#updateLink(org.apache.jetspeed.om.page.Link)

removeLink

public void removeLink(org.apache.jetspeed.om.page.Link link)
                throws org.apache.jetspeed.exception.JetspeedException

removeLink

Specified by:

removeLink in interface org.apache.jetspeed.page.PageManager

Throws:

org.apache.jetspeed.exception.JetspeedException

See Also:

org.apache.jetspeed.services.page.PageManagerService#removeLink(org.apache.jetspeed.om.page.Link)

getPageSecurity

public org.apache.jetspeed.om.page.PageSecurity getPageSecurity()
                                                         throws org.apache.jetspeed.page.document.DocumentNotFoundException,
                                                                org.apache.jetspeed.page.document.UnsupportedDocumentTypeException,
                                                                org.apache.jetspeed.om.folder.FolderNotFoundException,
                                                                org.apache.jetspeed.page.document.NodeException

getPageSecurity

Specified by:

getPageSecurity in interface org.apache.jetspeed.page.PageManager

Returns:

page security instance

Throws:

org.apache.jetspeed.page.document.DocumentNotFoundException

org.apache.jetspeed.page.document.UnsupportedDocumentTypeException

org.apache.jetspeed.page.document.NodeException

org.apache.jetspeed.om.folder.FolderNotFoundException

See Also:

PageManager.getPageSecurity()

getFolder

public org.apache.jetspeed.om.folder.Folder getFolder(String folderPath)
                                               throws org.apache.jetspeed.om.folder.FolderNotFoundException,
                                                      org.apache.jetspeed.om.folder.InvalidFolderException,
                                                      org.apache.jetspeed.page.document.NodeException

getFolder

Specified by:

getFolder in interface org.apache.jetspeed.page.PageManager

Parameters:

folderPath -

Returns:

folder instance

Throws:

org.apache.jetspeed.om.folder.FolderNotFoundException

org.apache.jetspeed.page.document.NodeException

org.apache.jetspeed.om.folder.InvalidFolderException

See Also:

PageManager.getFolder(java.lang.String)

updateFolder

public void updateFolder(org.apache.jetspeed.om.folder.Folder folder)
                  throws org.apache.jetspeed.exception.JetspeedException

updateFolder

Specified by:

updateFolder in interface org.apache.jetspeed.page.PageManager

Throws:

org.apache.jetspeed.exception.JetspeedException

See Also:

org.apache.jetspeed.services.page.PageManagerService#updateFolder(org.apache.jetspeed.om.folder.Folder)

removeFolder

public void removeFolder(org.apache.jetspeed.om.folder.Folder folder)
                  throws org.apache.jetspeed.exception.JetspeedException

removeFolder

Specified by:

removeFolder in interface org.apache.jetspeed.page.PageManager

Throws:

org.apache.jetspeed.exception.JetspeedException

See Also:

org.apache.jetspeed.services.page.PageManagerService#removeFolder(org.apache.jetspeed.om.folder.Folder)

getNodeFolder

private FolderImpl getNodeFolder(String nodePath)
                          throws org.apache.jetspeed.page.document.NodeException,
                                 org.apache.jetspeed.om.folder.InvalidFolderException

getNodeFolder - get folder implementation associated with specifed path

Parameters:

nodePath -

Returns:

folder impl instance

Throws:

org.apache.jetspeed.page.document.NodeException

org.apache.jetspeed.om.folder.InvalidFolderException

getNodeName

private String getNodeName(String nodePath)

getNodeFolder - get name of node from specified path

Parameters:

nodePath -

Returns:

name of node

refresh

public void refresh(org.apache.jetspeed.cache.file.FileCacheEntry entry)
             throws Exception

refresh file cache entry

Specified by:

refresh in interface org.apache.jetspeed.cache.file.FileCacheEventListener

Parameters:

entry -

Throws:

Exception

See Also:

FileCacheEventListener.refresh(org.apache.jetspeed.cache.file.FileCacheEntry)

evict

public void evict(org.apache.jetspeed.cache.file.FileCacheEntry entry)
           throws Exception

evict file cache entry

Specified by:

evict in interface org.apache.jetspeed.cache.file.FileCacheEventListener

Parameters:

entry -

Throws:

Exception

See Also:

FileCacheEventListener.evict(org.apache.jetspeed.cache.file.FileCacheEntry)

getContentPage

public org.apache.jetspeed.om.page.ContentPage getContentPage(String path)
                                                       throws org.apache.jetspeed.page.PageNotFoundException,
                                                              org.apache.jetspeed.page.document.NodeException

Specified by:

getContentPage in interface org.apache.jetspeed.page.PageManager

Throws:

org.apache.jetspeed.page.PageNotFoundException

org.apache.jetspeed.page.document.NodeException