com.aspc.wiki

Class WikiFileProvider

java.lang.Object

com.aspc.wiki.WikiFileProvider

All Implemented Interfaces:

WikiPageProvider, WikiProvider

public class WikiFileProvider
extends java.lang.Object
implements WikiPageProvider

WIKI file provider
THREAD MODE: SINGLE-THREADED

Since:

3 Oct 2010

Author:

Lahav

Field Summary

Fields inherited from interface com.ecyrd.jspwiki.WikiProvider

LATEST_VERSION

Constructor Summary

Constructors

Constructor and Description
WikiFileProvider()

Method Summary

Modifier and Type	Method and Description
void	deletePage(java.lang.String pageName) Removes an entire page from the repository.
void	deleteVersion(java.lang.String pageName, int version) Removes a specific version from the repository.
java.util.Collection	findPages(QueryItem[] query) Finds pages based on the query.
java.util.Collection	getAllChangedSince(java.util.Date date) Gets a list of recent changes.
java.util.Collection	getAllPages() Returns all pages.
int	getPageCount() Gets the number of pages.
WikiPage	getPageInfo(java.lang.String page, int version) Returns info about the page.
DBObject	getPageObject(java.lang.String page) Gets a page object.
java.lang.String	getPageText(java.lang.String page, int version) Gets a specific version out of the repository.
java.lang.String	getProviderInfo() Return a valid HTML string for information.
java.util.List	getVersionHistory(java.lang.String page) Returns version history.
void	initialize(WikiEngine engine, java.util.Properties properties) Initializes the page provider.
void	movePage(java.lang.String from, java.lang.String to) Move a page
boolean	pageExists(java.lang.String page) Return true, if page exists.
void	putPageText(WikiPage page, java.lang.String text) Attempts to save the page text for page "page".

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiFileProvider

public WikiFileProvider()

Method Detail

initialize

public void initialize(WikiEngine engine,
                       java.util.Properties properties)
                throws NoRequiredPropertyException,
                       java.io.IOException,
                       java.io.FileNotFoundException

Initializes the page provider.

Specified by:

initialize in interface WikiProvider

Parameters:

engine - WikiEngine to own this provider

properties - A set of properties used to initialize this provider

Throws:

java.io.FileNotFoundException - If the specified page directory does not exist.

java.io.IOException - In case the specified page directory is a file, not a directory.

NoRequiredPropertyException - If the provider needs a property which is not found in the property set

putPageText

public void putPageText(WikiPage page,
                        java.lang.String text)
                 throws ProviderException

Description copied from interface: WikiPageProvider

Attempts to save the page text for page "page". Note that the provider creates a new version regardless of what the version parameter of the WikiPage is.

Specified by:

putPageText in interface WikiPageProvider

Parameters:

page - the page

text - the text

Throws:

ProviderException - a problem

pageExists

public boolean pageExists(java.lang.String page)

Return true, if page exists.

Specified by:

pageExists in interface WikiPageProvider

Parameters:

page - The page name.

Returns:

true, if the page exists; false otherwise.

findPages

public java.util.Collection findPages(QueryItem[] query)

Finds pages based on the query. Only applicable to providers which implement the FastSearch interface. Otherwise JSPWiki will use its internal cache.

This method should really be a part of the FastSearch IF.

Specified by:

findPages in interface WikiPageProvider

Parameters:

query - An array of QueryItems to match

Returns:

A Collection of WikiPages.

getPageInfo

public WikiPage getPageInfo(java.lang.String page,
                            int version)
                     throws ProviderException

Returns info about the page.

Specified by:

getPageInfo in interface WikiPageProvider

Parameters:

page - The page name

version - The version number

Returns:

A filled WikiPage.

Throws:

ProviderException - If something goes wrong.

getAllPages

public java.util.Collection getAllPages()
                                 throws ProviderException

Returns all pages. Each element in the returned Collection should be a WikiPage.

Specified by:

getAllPages in interface WikiPageProvider

Returns:

A collection of WikiPages

Throws:

ProviderException - If something goes wrong.

getAllChangedSince

public java.util.Collection getAllChangedSince(java.util.Date date)

Gets a list of recent changes.

Specified by:

getAllChangedSince in interface WikiPageProvider

Parameters:

date - The date to check from

Returns:

A Collection of WikiPages

getPageCount

public int getPageCount()
                 throws ProviderException

Gets the number of pages.

Specified by:

getPageCount in interface WikiPageProvider

Returns:

The number of pages in the repository

Throws:

ProviderException - If something goes wrong

getVersionHistory

public java.util.List getVersionHistory(java.lang.String page)
                                 throws ProviderException

Returns version history. Each element should be a WikiPage.

Specified by:

getVersionHistory in interface WikiPageProvider

Parameters:

page - The name of the page to get the history from.

Returns:

A collection of WikiPages.

Throws:

ProviderException - If something goes wrong.

getPageText

public java.lang.String getPageText(java.lang.String page,
                                    int version)
                             throws ProviderException

Gets a specific version out of the repository.

Specified by:

getPageText in interface WikiPageProvider

Parameters:

page - Name of the page to fetch.

version - Version of the page to fetch.

Returns:

The content of the page, or null, if the page does not exist.

Throws:

ProviderException - If something goes wrong.

getPageObject

public DBObject getPageObject(java.lang.String page)
                       throws ProviderException

Gets a page object.

Specified by:

getPageObject in interface WikiPageProvider

Parameters:

page - Name of the page to fetch.

Returns:

The page object, or null, if the page does not exist.

Throws:

ProviderException - If something goes wrong.

deleteVersion

public void deleteVersion(java.lang.String pageName,
                          int version)
                   throws ProviderException

Removes a specific version from the repository. The implementations should really do no more security checks, since that is the domain of the PageManager. Just delete it as efficiently as you can.

Specified by:

deleteVersion in interface WikiPageProvider

Parameters:

pageName - Name of the page to be removed.

version - Version of the page to be removed. May be LATEST_VERSION.

Throws:

ProviderException - If the page cannot be removed for some reason.

deletePage

public void deletePage(java.lang.String pageName)
                throws ProviderException

Removes an entire page from the repository. The implementations should really do no more security checks, since that is the domain of the PageManager. Just delete it as efficiently as you can. You should also delete any auxiliary files that belong to this page, IF they were created by this provider.

The reason why this is named differently from deleteVersion() (logically, this method should be an overloaded version) is that I want to be absolutely sure I don't accidentally use the wrong method. With overloading something like that happens sometimes...

Specified by:

deletePage in interface WikiPageProvider

Parameters:

pageName - Name of the page to be removed completely.

Throws:

ProviderException - If the page could not be removed for some reason.

movePage

public void movePage(java.lang.String from,
                     java.lang.String to)
              throws ProviderException

Move a page

Specified by:

movePage in interface WikiPageProvider

Parameters:

from - Name of the page to move.

to - New name of the page.

Throws:

ProviderException - If the page could not be moved for some reason.

getProviderInfo

public java.lang.String getProviderInfo()

Return a valid HTML string for information. May be anything.

Specified by:

getProviderInfo in interface WikiProvider

Returns:

A string describing the provider.