org.apache.wiki.providers

Class CachingProvider

java.lang.Object

org.apache.wiki.providers.CachingProvider

All Implemented Interfaces:

PageProvider, WikiProvider

public class CachingProvider
extends Object
implements PageProvider

Provides a caching page provider. This class rests on top of a real provider class and provides a cache to speed things up. Only if the cache copy of the page text has expired, we fetch it from the provider.

This class does not detect if someone has modified the page externally, not through JSPWiki routines.

Heavily based on ideas by Chris Brooking.

Since 2.10 uses the Ehcache library.

Since:

1.6.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_NAME Name of the regular page cache.
static int	DEFAULT_CACHECAPACITY
static int	DEFAULT_CACHETIMETOIDLESECONDS
static int	DEFAULT_CACHETIMETOLIVESECONDS
static String	HISTORYCACHE_NAME Name of the page history cache.
static String	TEXTCACHE_NAME Name of the page text cache.

Fields inherited from interface org.apache.wiki.api.providers.WikiProvider

LATEST_VERSION

Constructor Summary

Constructors

Constructor and Description
CachingProvider()

Method Summary

Modifier and Type	Method and Description
void	deletePage(String pageName)
void	deleteVersion(String pageName, int version)
Collection<SearchResult>	findPages(QueryItem[] query)
Collection<Page>	getAllChangedSince(Date date)
Collection<Page>	getAllPages()
int	getPageCount()
Page	getPageInfo(String pageName, int version)
String	getPageText(String pageName, int version)
String	getProviderInfo() Gets the provider class name, and cache statistics (misscount and hitcount of page cache and history cache).
PageProvider	getRealProvider() Returns the actual used provider.
List<Page>	getVersionHistory(String pageName)
void	initialize(Engine engine, Properties properties)
void	movePage(String from, String to)
boolean	pageExists(String pageName)
boolean	pageExists(String pageName, int version)
void	putPageText(Page page, String text)

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_NAME

public static final String CACHE_NAME

Name of the regular page cache.

See Also:

Constant Field Values

TEXTCACHE_NAME

public static final String TEXTCACHE_NAME

Name of the page text cache.

See Also:

Constant Field Values

HISTORYCACHE_NAME

public static final String HISTORYCACHE_NAME

Name of the page history cache.

See Also:

Constant Field Values

DEFAULT_CACHECAPACITY

public static final int DEFAULT_CACHECAPACITY

See Also:

Constant Field Values

DEFAULT_CACHETIMETOLIVESECONDS

public static final int DEFAULT_CACHETIMETOLIVESECONDS

See Also:

Constant Field Values

DEFAULT_CACHETIMETOIDLESECONDS

public static final int DEFAULT_CACHETIMETOIDLESECONDS

See Also:

Constant Field Values

Constructor Detail

CachingProvider

public CachingProvider()

Method Detail

initialize

public void initialize(Engine engine,
                       Properties properties)
                throws NoRequiredPropertyException,
                       IOException

Specified by:

initialize in interface WikiProvider

Throws:

NoRequiredPropertyException

IOException

pageExists

public boolean pageExists(String pageName,
                          int version)

Specified by:

pageExists in interface PageProvider

pageExists

public boolean pageExists(String pageName)

Specified by:

pageExists in interface PageProvider

getPageText

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

Specified by:

getPageText in interface PageProvider

Throws:

ProviderException

putPageText

public void putPageText(Page page,
                        String text)
                 throws ProviderException

Specified by:

putPageText in interface PageProvider

Throws:

ProviderException

getAllPages

public Collection<Page> getAllPages()
                             throws ProviderException

Specified by:

getAllPages in interface PageProvider

Throws:

ProviderException

getAllChangedSince

public Collection<Page> getAllChangedSince(Date date)

Specified by:

getAllChangedSince in interface PageProvider

getPageCount

public int getPageCount()
                 throws ProviderException

Specified by:

getPageCount in interface PageProvider

Throws:

ProviderException

findPages

public Collection<SearchResult> findPages(QueryItem[] query)

Specified by:

findPages in interface PageProvider

getPageInfo

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

Specified by:

getPageInfo in interface PageProvider

Throws:

ProviderException

getVersionHistory

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

Specified by:

getVersionHistory in interface PageProvider

Throws:

ProviderException

getProviderInfo

public String getProviderInfo()

Gets the provider class name, and cache statistics (misscount and hitcount of page cache and history cache).

Specified by:

getProviderInfo in interface WikiProvider

Returns:

A plain string with all the above mentioned values.

deleteVersion

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

Specified by:

deleteVersion in interface PageProvider

Throws:

ProviderException

deletePage

public void deletePage(String pageName)
                throws ProviderException

Specified by:

deletePage in interface PageProvider

Throws:

ProviderException

movePage

public void movePage(String from,
                     String to)
              throws ProviderException

Specified by:

movePage in interface PageProvider

Throws:

ProviderException

getRealProvider

public PageProvider getRealProvider()

Returns the actual used provider.

Returns:

The real provider.

Since:

2.0