org.apache.wiki.pages

Class DefaultPageManager

java.lang.Object

org.apache.wiki.modules.ModuleManager

org.apache.wiki.pages.DefaultPageManager

All Implemented Interfaces:

EventListener, WikiEventListener, PageManager

public class DefaultPageManager
extends ModuleManager
implements PageManager

Manages the WikiPages. This class functions as an unified interface towards the page providers. It handles initialization and management of the providers, and provides utility methods for accessing the contents.

Saving a page is a two-stage Task; first the pre-save operations and then the actual save. See the descriptions of the tasks for further information.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentHashMap<String,PageLock>	m_pageLocks

Fields inherited from class org.apache.wiki.modules.ModuleManager

m_engine, PLUGIN_RESOURCE_LOCATION

Fields inherited from interface org.apache.wiki.pages.PageManager

PROP_LOCKEXPIRY, PROP_PAGEPROVIDER, PROP_USECACHE

Constructor Summary

Constructors

Constructor and Description
DefaultPageManager(WikiEngine engine, Properties props) Creates a new PageManager.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(WikiEvent event) Listens for WikiSecurityEvent.PROFILE_NAME_CHANGED events.
protected boolean	changeAcl(WikiPage page, Principal[] oldPrincipals, Principal newPrincipal) For a single wiki page, replaces all Acl entries matching a supplied array of Principals with a new Principal.
void	deletePage(WikiPage page) Deletes an entire page, all versions, all traces.
void	deleteVersion(WikiPage page) Deletes only a specific version of a WikiPage.
protected void	fireEvent(int type, String pagename) Fires a WikiPageEvent of the provided type and page name to all registered listeners.
List<PageLock>	getActiveLocks() Returns a list of currently applicable locks.
Collection<WikiPage>	getAllPages() Returns all pages in some random order.
PageLock	getCurrentLock(WikiPage page) Returns the current lock owner of a page.
WikiEngine	getEngine() Returns the WikiEngine to which this PageManager belongs to.
WikiModuleInfo	getModuleInfo(String moduleName) Returns null!
WikiPage	getPageInfo(String pageName, int version) Finds a WikiPage object describing a particular page and version.
PageSorter	getPageSorter() Returns the configured PageSorter.
String	getPageText(String pageName, int version) Fetches the page text from the repository.
WikiPageProvider	getProvider() Returns the page provider currently in use.
String	getProviderDescription() Returns a human-readable description of the current provider.
int	getTotalPageCount() Returns the total count of all pages in the repository.
List<WikiPage>	getVersionHistory(String pageName) Gets a version history of page.
PageLock	lockPage(WikiPage page, String user) Locks page for editing.
Collection<WikiModuleInfo>	modules() Returns a collection of modules currently managed by this ModuleManager.
boolean	pageExists(String pageName) Returns true, if the page exists (any version).
boolean	pageExists(String pageName, int version) Checks for existence of a specific page and version.
void	putPageText(WikiPage page, String content) Puts the page text into the repository.
void	unlockPage(PageLock lock) Marks a page free to be written again.

Methods inherited from class org.apache.wiki.modules.ModuleManager

checkCompatibility, modules

Methods inherited from class java.lang.Object

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

Field Detail

m_pageLocks

protected ConcurrentHashMap<String,PageLock> m_pageLocks

Constructor Detail

DefaultPageManager

public DefaultPageManager(WikiEngine engine,
                          Properties props)
                   throws NoSuchElementException,
                          WikiException

Creates a new PageManager.

Parameters:

engine - WikiEngine instance

props - Properties to use for initialization

Throws:

NoSuchElementException - property not found on WikiEngine properties

WikiException - If anything goes wrong, you get this.

Method Detail

getProvider

public WikiPageProvider getProvider()

Description copied from interface: PageManager

Returns the page provider currently in use.

Specified by:

getProvider in interface PageManager

Returns:

A WikiPageProvider instance.

getAllPages

public Collection<WikiPage> getAllPages()
                                 throws ProviderException

Description copied from interface: PageManager

Returns all pages in some random order. If you need just the page names, please see ReferenceManager#findCreated(), which is probably a lot faster. This method may cause repository access.

Specified by:

getAllPages in interface PageManager

Returns:

A Collection of WikiPage objects.

Throws:

ProviderException - If the backend has problems.

getPageText

public String getPageText(String pageName,
                          int version)
                   throws ProviderException

Description copied from interface: PageManager

Fetches the page text from the repository. This method also does some sanity checks, like checking for the pageName validity, etc. Also, if the page repository has been modified externally, it is smart enough to handle such occurrences.

Specified by:

getPageText in interface PageManager

Parameters:

pageName - The name of the page to fetch.

version - The version to find

Returns:

The page content as a raw string

Throws:

ProviderException - If the backend has issues.

getEngine

public WikiEngine getEngine()

Description copied from interface: PageManager

Returns the WikiEngine to which this PageManager belongs to.

Specified by:

getEngine in interface PageManager

Returns:

The WikiEngine object.

putPageText

public void putPageText(WikiPage page,
                        String content)
                 throws ProviderException

Description copied from interface: PageManager

Puts the page text into the repository. Note that this method does NOT update JSPWiki internal data structures, and therefore you should always use WikiEngine.saveText()

Specified by:

putPageText in interface PageManager

Parameters:

page - Page to save

content - Wikimarkup to save

Throws:

ProviderException - If something goes wrong in the saving phase

lockPage

public PageLock lockPage(WikiPage page,
                         String user)

Description copied from interface: PageManager

Locks page for editing. Note, however, that the PageManager will in no way prevent you from actually editing this page; the lock is just for information.

Specified by:

lockPage in interface PageManager

Parameters:

page - WikiPage to lock

user - Username to use for locking

Returns:

null, if page could not be locked.

unlockPage

public void unlockPage(PageLock lock)

Description copied from interface: PageManager

Marks a page free to be written again. If there has not been a lock, will fail quietly.

Specified by:

unlockPage in interface PageManager

Parameters:

lock - A lock acquired in lockPage(). Safe to be null.

getCurrentLock

public PageLock getCurrentLock(WikiPage page)

Description copied from interface: PageManager

Returns the current lock owner of a page. If the page is not locked, will return null.

Specified by:

getCurrentLock in interface PageManager

Parameters:

page - The page to check the lock for

Returns:

Current lock, or null, if there is no lock

getActiveLocks

public List<PageLock> getActiveLocks()

Description copied from interface: PageManager

Returns a list of currently applicable locks. Note that by the time you get the list, the locks may have already expired, so use this only for informational purposes.

Specified by:

getActiveLocks in interface PageManager

Returns:

List of PageLock objects, detailing the locks. If no locks exist, returns an empty list.

getPageInfo

public WikiPage getPageInfo(String pageName,
                            int version)
                     throws ProviderException

Description copied from interface: PageManager

Finds a WikiPage object describing a particular page and version.

Specified by:

getPageInfo in interface PageManager

Parameters:

pageName - The name of the page

version - A version number

Returns:

A WikiPage object, or null, if the page does not exist

Throws:

ProviderException - If there is something wrong with the page name or the repository

getVersionHistory

public List<WikiPage> getVersionHistory(String pageName)
                                 throws ProviderException

Description copied from interface: PageManager

Gets a version history of page. Each element in the returned List is a WikiPage.

Specified by:

getVersionHistory in interface PageManager

Parameters:

pageName - The name of the page to fetch history for

Returns:

If the page does not exist, returns null, otherwise a List of WikiPages.

Throws:

ProviderException - If the repository fails.

getProviderDescription

public String getProviderDescription()

Description copied from interface: PageManager

Returns a human-readable description of the current provider.

Specified by:

getProviderDescription in interface PageManager

Returns:

A human-readable description.

getTotalPageCount

public int getTotalPageCount()

Description copied from interface: PageManager

Returns the total count of all pages in the repository. This method is equivalent of calling getAllPages().size(), but it swallows the ProviderException and returns -1 instead of any problems.

Specified by:

getTotalPageCount in interface PageManager

Returns:

The number of pages, or -1, if there is an error.

pageExists

public boolean pageExists(String pageName)
                   throws ProviderException

Description copied from interface: PageManager

Returns true, if the page exists (any version).

Specified by:

pageExists in interface PageManager

Parameters:

pageName - Name of the page.

Returns:

A boolean value describing the existence of a page

Throws:

ProviderException - If the backend fails or the name is illegal.

pageExists

public boolean pageExists(String pageName,
                          int version)
                   throws ProviderException

Description copied from interface: PageManager

Checks for existence of a specific page and version.

Specified by:

pageExists in interface PageManager

Parameters:

pageName - Name of the page

version - The version to check

Returns:

true if the page exists, false otherwise

Throws:

ProviderException - If backend fails or name is illegal

deleteVersion

public void deleteVersion(WikiPage page)
                   throws ProviderException

Description copied from interface: PageManager

Deletes only a specific version of a WikiPage.

Specified by:

deleteVersion in interface PageManager

Parameters:

page - The page to delete.

Throws:

ProviderException - if the page fails

deletePage

public void deletePage(WikiPage page)
                throws ProviderException

Description copied from interface: PageManager

Deletes an entire page, all versions, all traces.

Specified by:

deletePage in interface PageManager

Parameters:

page - The WikiPage to delete

Throws:

ProviderException - If the repository operation fails

fireEvent

protected final void fireEvent(int type,
                               String pagename)

Fires a WikiPageEvent of the provided type and page name to all registered listeners.

Parameters:

type - the event type to be fired

pagename - the wiki page name as a String

See Also:

WikiPageEvent

modules

public Collection<WikiModuleInfo> modules()

Returns a collection of modules currently managed by this ModuleManager. Each entry is an instance of the WikiModuleInfo class. This method should return something which is safe to iterate over, even if the underlying collection changes.

Specified by:

modules in class ModuleManager

Returns:

A Collection of WikiModuleInfo instances.

getModuleInfo

public WikiModuleInfo getModuleInfo(String moduleName)

Returns null! Returns the WikiModuleInfo information about the provided moduleName.

Specified by:

getModuleInfo in class ModuleManager

Returns:

The wikiModuleInfo

actionPerformed

public void actionPerformed(WikiEvent event)

Description copied from interface: PageManager

Listens for WikiSecurityEvent.PROFILE_NAME_CHANGED events. If a user profile's name changes, each page ACL is inspected. If an entry contains a name that has changed, it is replaced with the new one. No events are emitted as a consequence of this method, because the page contents are still the same; it is only the representations of the names within the ACL that are changing.

Specified by:

actionPerformed in interface WikiEventListener

Specified by:

actionPerformed in interface PageManager

Parameters:

event - The event

changeAcl

protected boolean changeAcl(WikiPage page,
                            Principal[] oldPrincipals,
                            Principal newPrincipal)

For a single wiki page, replaces all Acl entries matching a supplied array of Principals with a new Principal.

Parameters:

page - the wiki page whose Acl is to be modified

oldPrincipals - an array of Principals to replace; all AclEntry objects whose AclEntry.getPrincipal() method returns one of these Principals will be replaced

newPrincipal - the Principal that should receive the old Principals' permissions

Returns:

true if the Acl was actually changed; false otherwise

getPageSorter

public PageSorter getPageSorter()

Description copied from interface: PageManager

Returns the configured PageSorter.

Specified by:

getPageSorter in interface PageManager

Returns:

the configured PageSorter.