PageManager (Apache JSPWiki 2.11.0.M6 API)

All Superinterfaces:

EventListener, WikiEventListener

All Known Implementing Classes:

DefaultPageManager
```
public interface PageManager
extends WikiEventListener
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROP_LOCKEXPIRY` The property value for setting the amount of time before the page locks expire.
`static String`	`PROP_PAGEPROVIDER` The property value for setting the current page provider.
`static String`	`PROP_USECACHE` The property value for setting the cache on/off.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(WikiEvent event)` Listens for `WikiSecurityEvent.PROFILE_NAME_CHANGED` events.
`void`	`deletePage(WikiPage page)` Deletes an entire page, all versions, all traces.
`void`	`deleteVersion(WikiPage page)` Deletes only a specific version of a WikiPage.
`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.
`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.
`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.

- Field Detail
  - PROP_PAGEPROVIDER
```
static final String PROP_PAGEPROVIDER
```
    The property value for setting the current page provider. Value is "jspwiki.pageProvider".
    
    See Also:
    
    Constant Field Values
  - PROP_USECACHE
```
static final String PROP_USECACHE
```
    The property value for setting the cache on/off. Value is "jspwiki.usePageCache".
    
    See Also:
    
    Constant Field Values
  - PROP_LOCKEXPIRY
```
static final String PROP_LOCKEXPIRY
```
    The property value for setting the amount of time before the page locks expire. Value is "jspwiki.lockExpiryTime".
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getProvider
```
WikiPageProvider getProvider()
```
    Returns the page provider currently in use.
    
    Returns:
    
    A WikiPageProvider instance.
  - getAllPages
```
Collection<WikiPage> getAllPages()
                          throws ProviderException
```
    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.
    
    Returns:
    
    A Collection of WikiPage objects.
    
    Throws:
    
    ProviderException - If the backend has problems.
  - getPageText
```
String getPageText(String pageName,
                   int version)
            throws ProviderException
```
    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.
    
    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
```
WikiEngine getEngine()
```
    Returns the WikiEngine to which this PageManager belongs to.
    
    Returns:
    
    The WikiEngine object.
  - putPageText
```
void putPageText(WikiPage page,
                 String content)
          throws ProviderException
```
    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()
    
    Parameters:
    
    page - Page to save
    
    content - Wikimarkup to save
    
    Throws:
    
    ProviderException - If something goes wrong in the saving phase
  - lockPage
```
PageLock lockPage(WikiPage page,
                  String user)
```
    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.
    
    Parameters:
    
    page - WikiPage to lock
    
    user - Username to use for locking
    
    Returns:
    
    null, if page could not be locked.
  - unlockPage
```
void unlockPage(PageLock lock)
```
    Marks a page free to be written again. If there has not been a lock, will fail quietly.
    
    Parameters:
    
    lock - A lock acquired in lockPage(). Safe to be null.
  - getCurrentLock
```
PageLock getCurrentLock(WikiPage page)
```
    Returns the current lock owner of a page. If the page is not locked, will return null.
    
    Parameters:
    
    page - The page to check the lock for
    
    Returns:
    
    Current lock, or null, if there is no lock
  - getActiveLocks
```
List<PageLock> getActiveLocks()
```
    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.
    
    Returns:
    
    List of PageLock objects, detailing the locks. If no locks exist, returns an empty list.
    
    Since:
    
    2.0.22.
  - getPageInfo
```
WikiPage getPageInfo(String pageName,
                     int version)
              throws ProviderException
```
    Finds a WikiPage object describing a particular page and version.
    
    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
```
List<WikiPage> getVersionHistory(String pageName)
                          throws ProviderException
```
    Gets a version history of page. Each element in the returned List is a WikiPage.
    
    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
```
String getProviderDescription()
```
    Returns a human-readable description of the current provider.
    
    Returns:
    
    A human-readable description.
  - getTotalPageCount
```
int getTotalPageCount()
```
    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.
    
    Returns:
    
    The number of pages, or -1, if there is an error.
  - pageExists
```
boolean pageExists(String pageName)
            throws ProviderException
```
    Returns true, if the page exists (any version).
    
    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
```
boolean pageExists(String pageName,
                   int version)
            throws ProviderException
```
    Checks for existence of a specific page and version.
    
    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
    
    Since:
    
    2.3.29
  - deleteVersion
```
void deleteVersion(WikiPage page)
            throws ProviderException
```
    Deletes only a specific version of a WikiPage.
    
    Parameters:
    
    page - The page to delete.
    
    Throws:
    
    ProviderException - if the page fails
  - deletePage
```
void deletePage(WikiPage page)
         throws ProviderException
```
    Deletes an entire page, all versions, all traces.
    
    Parameters:
    
    page - The WikiPage to delete
    
    Throws:
    
    ProviderException - If the repository operation fails
  - actionPerformed
```
void actionPerformed(WikiEvent event)
```
    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
    
    Parameters:
    
    event - The event
  - getPageSorter
```
PageSorter getPageSorter()
```
    Returns the configured PageSorter.
    
    Returns:
    
    the configured PageSorter.

Interface PageManager

Field Summary

Method Summary

Field Detail

PROP_PAGEPROVIDER

PROP_USECACHE

PROP_LOCKEXPIRY

Method Detail

getProvider

getAllPages

getPageText

getEngine

putPageText

lockPage

unlockPage

getCurrentLock

getActiveLocks

getPageInfo

getVersionHistory

getProviderDescription

getTotalPageCount

pageExists

pageExists

deleteVersion

deletePage

actionPerformed

getPageSorter