org.exoplatform.wiki.rendering.cache
Interface PageRenderingCacheService

All Known Implementing Classes:

PageRenderingCacheServiceImpl

public interface PageRenderingCacheService

This service Manage the Rendering Cache of wiki pages. The cache storage store all html markup from page wiki markup. Therefore, it saves much time in rendering markup, especially with long content page. Generally, its workflow as: Open a page, does this page's html markup exist in the cache ? - Yes = reuse this one. - No = Render the page and add to the cache. Editing a page = invalidating the cache page.

Method Summary

void	addPageLink(WikiPageParams param, WikiPageParams entity) Record a link between two pages
Map<WikiPageParams,List<WikiPageParams>>	getPageLinksMap() Return the collection of connections of page.
String	getRenderedContent(WikiPageParams param, String targetSyntax) Get rendered content of a wiki page
org.exoplatform.services.cache.ExoCache<MarkupKey,MarkupData>	getRenderingCache() Get the rendering cache
void	invalidateCache(WikiPageParams param) Invalidate all cache entries link to a page in case this page is removed, changed or renamed...

Method Detail

getRenderedContent

String getRenderedContent(WikiPageParams param,
                          String targetSyntax)

Get rendered content of a wiki page

Parameters:

param - the parameter to specify the wiki page

targetSyntax - the syntax to be display

Returns:

the rendered content

getRenderingCache

org.exoplatform.services.cache.ExoCache<MarkupKey,MarkupData> getRenderingCache()

Get the rendering cache

Returns:

the rendering cache

getPageLinksMap

Map<WikiPageParams,List<WikiPageParams>> getPageLinksMap()

Return the collection of connections of page. In details, a connections is built if in content of a page, there is a link to another page

Returns:

the map of connection

addPageLink

void addPageLink(WikiPageParams param,
                 WikiPageParams entity)

Record a link between two pages

Parameters:

param - identity parameter of a page to add

entity - identity parameter of page to be added

invalidateCache

void invalidateCache(WikiPageParams param)

Invalidate all cache entries link to a page in case this page is removed, changed or renamed...

Parameters:

param - specify identity of a page