org.exoplatform.wiki.rendering.cache

Interface PageRenderingCacheService

public interface PageRenderingCacheService

Manages the Rendering Cache of wiki pages. The cache stores all HTML markups from the wiki page markups. Therefore, it saves much time in rendering markups, especially with a long content page. Generally, its workflow is as follows:

• Open a page, does the page HTML markup exist in the cache?
  • Yes = Reuses this one.
  • No = Renders the page and adds the page HTML markup to the cache.
• Editing a page = Invalidates the page HTML markup in the cache.

Level API:

Experimental

Method Summary

Methods

Modifier and Type	Method and Description
void	addPageLink(org.exoplatform.wiki.service.WikiPageParams param, org.exoplatform.wiki.service.WikiPageParams entity) Adds a link between two pages.
void	addUnCachedMacro(org.exoplatform.wiki.rendering.cache.UnCachedMacroPlugin plugin) adds plugin containing uncached macro list
int	getAttachmentCount(org.exoplatform.wiki.mow.core.api.wiki.PageImpl page) Get number of attachment of a wiki page
org.exoplatform.wiki.mow.api.Page	getPageByParams(org.exoplatform.wiki.service.WikiPageParams param) Gets the wiki page object by params
Map<org.exoplatform.wiki.service.WikiPageParams,List<org.exoplatform.wiki.service.WikiPageParams>>	getPageLinksMap() Returns a collection of connections of a wiki page.
String	getRenderedContent(org.exoplatform.wiki.service.WikiPageParams param, String targetSyntax) Gets the rendered content of a wiki page.
ExoCache<Integer,org.exoplatform.wiki.rendering.cache.MarkupData>	getRenderingCache() Gets the rendering cache.
Set<String>	getUncachedMacroes() gets the list of uncached macroes
void	invalidateAttachmentCache(org.exoplatform.wiki.service.WikiPageParams param) Invalidate cache storing attachment size of a wiki page
void	invalidateCache(org.exoplatform.wiki.service.WikiPageParams param) Invalidates all cache entries linking to a page in case this page is removed, changed or renamed.
void	invalidateUUIDCache(org.exoplatform.wiki.service.WikiPageParams param) Invalidates the cache entry containing given wiki page param

Method Detail

getRenderedContent

String getRenderedContent(org.exoplatform.wiki.service.WikiPageParams param,
                        String targetSyntax)

Gets the rendered content of a wiki page.

Parameters:

param - The parameter which specifies the wiki page.

targetSyntax - The syntax to be displayed.

Returns:

The rendered content.

getPageByParams

org.exoplatform.wiki.mow.api.Page getPageByParams(org.exoplatform.wiki.service.WikiPageParams param)

Gets the wiki page object by params

Parameters:

param - the wiki page param

Returns:

the wiki page

getAttachmentCount

int getAttachmentCount(org.exoplatform.wiki.mow.core.api.wiki.PageImpl page)

Get number of attachment of a wiki page

Parameters:

param - the parameter to specify the wiki page

targetSyntax - the syntax to be display

Returns:

the attachment size

getRenderingCache

ExoCache<Integer,org.exoplatform.wiki.rendering.cache.MarkupData> getRenderingCache()

Gets the rendering cache.

Returns:

The rendering cache.

getPageLinksMap

Map<org.exoplatform.wiki.service.WikiPageParams,List<org.exoplatform.wiki.service.WikiPageParams>> getPageLinksMap()

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

Returns:

The map of connections.

addPageLink

void addPageLink(org.exoplatform.wiki.service.WikiPageParams param,
               org.exoplatform.wiki.service.WikiPageParams entity)

Adds a link between two pages.

Parameters:

param - The identity parameter of the wiki page to add.

entity - The identity parameter of the wiki page to be added.

invalidateCache

void invalidateCache(org.exoplatform.wiki.service.WikiPageParams param)

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

Parameters:

param - The parameter which specifies the wiki page identity.

addUnCachedMacro

void addUnCachedMacro(org.exoplatform.wiki.rendering.cache.UnCachedMacroPlugin plugin)

adds plugin containing uncached macro list

Parameters:

plugin - the plugin

getUncachedMacroes

Set<String> getUncachedMacroes()

gets the list of uncached macroes

Returns:

the uncached macroes

invalidateUUIDCache

void invalidateUUIDCache(org.exoplatform.wiki.service.WikiPageParams param)

Invalidates the cache entry containing given wiki page param

Parameters:

param -

invalidateAttachmentCache

void invalidateAttachmentCache(org.exoplatform.wiki.service.WikiPageParams param)

Invalidate cache storing attachment size of a wiki page

Parameters:

param - specify identity of a page