org.ametys.web.cache.pageelement

Class PageElementCache

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.cache.pageelement.PageElementCache

All Implemented Interfaces:

Disposable, Component, Contextualizable, LogEnabled

public class PageElementCache
extends AbstractLogEnabled
implements Component, Contextualizable, Disposable

Cache the page elements renderings.
This class handles several caches, one per site and per JCR workspace.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Map<String,Map<String,Map<String,Map<String,Map<RenderingContext,SaxBuffer>>>>>>	_cache
private Context	_context
private Map<String,Map<String,Map<String,AtomicInteger>>>	_currentHitCount
private Map<String,Map<String,Map<String,AtomicInteger>>>	_hitCount
private Map<String,Map<String,Map<String,AtomicInteger>>>	_missCount
static String	DISABLE_PE_CACHE_ATTRIBUTE "Disable page element cache" request attribute.
static String	ROLE Avalon role.

Constructor Summary

Constructors

Constructor and Description
PageElementCache()

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all stored data.
void	clear(String workspace, String site) Removes all data associated with a JCR workspace and a site.
void	clear(String workspace, String site, String pageElementType) Removes all data associated with a JCR workspace, a site and a given element type.
void	contextualize(Context context)
void	dispose()
protected int	getCount(Map<String,Map<String,Map<String,AtomicInteger>>> countMap, String workspace, String siteName, String pageElementType) Get a hit or miss count for a workspace, site and page element type.
Map<String,Map<String,Map<RenderingContext,SaxBuffer>>>	getElementCache(String workspace, String site, String pageElementType) Returns all cached data for a given InputData, or null if none.
SaxBuffer	getPageElement(String workspace, String site, String pageElementType, String elementId, RenderingContext renderingContext) Returns the data in the cache, or null if none.
SaxBuffer	getPageElement(String workspace, String site, String pageElementType, String elementId, String subElementId, RenderingContext renderingContext) Returns the data in the cache, or null if none.
Set<String>	getPageElementTypes(String workspace, String site) Returns all stored element types, or null if none.
protected void	incrementCount(Map<String,Map<String,Map<String,AtomicInteger>>> countMap, String workspace, String siteName, String pageElementType) Add a hit count for a workspace, site and page element type.
protected boolean	isEnabled() Test if the cache is enabled.
protected void	logAndResetHitCount() Reset the hit count after logging the old value.
protected void	logAndResetHitCount(String workspace, String siteName) Reset the hit count after logging the old value.
protected void	logAndResetHitCount(String workspace, String siteName, String pageElementType) Reset the hit count after logging the old value.
protected void	logAndResetHitCount(String workspace, String siteName, String pageElementType, AtomicInteger hitCount) Reset the hit count after logging the old value.
protected void	logFullHitCount(String workspace, String siteName, String pageElementType) Log the full hit and miss count for a given workspace, site and page element type.
void	removeItem(String workspace, String site, String pageElementType, String elementId) Removes a single item from the cache.
void	storePageElement(String workspace, String site, String pageElementType, String elementId, RenderingContext renderingContext, SaxBuffer content) Add a content in the cache.
void	storePageElement(String workspace, String site, String pageElementType, String elementId, String subElementId, RenderingContext renderingContext, SaxBuffer content) Add a content in the cache.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

Avalon role.

DISABLE_PE_CACHE_ATTRIBUTE

public static final String DISABLE_PE_CACHE_ATTRIBUTE

"Disable page element cache" request attribute.

See Also:

Constant Field Values

_cache

private Map<String,Map<String,Map<String,Map<String,Map<String,Map<RenderingContext,SaxBuffer>>>>>> _cache

_currentHitCount

private Map<String,Map<String,Map<String,AtomicInteger>>> _currentHitCount

_hitCount

private Map<String,Map<String,Map<String,AtomicInteger>>> _hitCount

_missCount

private Map<String,Map<String,Map<String,AtomicInteger>>> _missCount

_context

private Context _context

Constructor Detail

PageElementCache

public PageElementCache()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

storePageElement

public void storePageElement(String workspace,
                             String site,
                             String pageElementType,
                             String elementId,
                             RenderingContext renderingContext,
                             SaxBuffer content)

Add a content in the cache.

Parameters:

workspace - the current JCR workspace.

site - the current site.

pageElementType - the page element type.

elementId - the element id (page id or zoneItem id).

renderingContext - the current rendering context.

content - the actual content.

storePageElement

public void storePageElement(String workspace,
                             String site,
                             String pageElementType,
                             String elementId,
                             String subElementId,
                             RenderingContext renderingContext,
                             SaxBuffer content)

Add a content in the cache.

Parameters:

workspace - the current JCR workspace.

site - the current site.

pageElementType - the page element type.

elementId - the element id (page id or zoneItem id).

subElementId - the sub-element id (page id, in case the element id is a zoneItem id).

renderingContext - the current rendering context.

content - the actual content.

getPageElement

public SaxBuffer getPageElement(String workspace,
                                String site,
                                String pageElementType,
                                String elementId,
                                RenderingContext renderingContext)

Returns the data in the cache, or null if none.

Parameters:

workspace - the current JCR workspace.

site - the current site.

pageElementType - the element type.

elementId - the element id (page id or zoneItem id).

renderingContext - the current rendering context.

Returns:

the stored content.

getPageElement

public SaxBuffer getPageElement(String workspace,
                                String site,
                                String pageElementType,
                                String elementId,
                                String subElementId,
                                RenderingContext renderingContext)

Returns the data in the cache, or null if none.

Parameters:

workspace - the current JCR workspace.

site - the current site.

pageElementType - the element type.

elementId - the element id (page id or zoneItem id).

subElementId - the sub-element id (page id, in case the element id is a zoneItem id).

renderingContext - the current rendering context.

Returns:

the stored content.

getPageElementTypes

public Set<String> getPageElementTypes(String workspace,
                                       String site)

Returns all stored element types, or null if none.

Parameters:

workspace - the current JCR workspace.

site - the current site.

Returns:

all stored element types.

getElementCache

public Map<String,Map<String,Map<RenderingContext,SaxBuffer>>> getElementCache(String workspace,
                                                                               String site,
                                                                               String pageElementType)

Returns all cached data for a given InputData, or null if none.

Parameters:

workspace - the current JCR workspace.

site - the current site.

pageElementType - the element type.

Returns:

the stored content.

removeItem

public void removeItem(String workspace,
                       String site,
                       String pageElementType,
                       String elementId)

Removes a single item from the cache.

Parameters:

workspace - the target JCR workspace or null to remove from all workspaces.

site - the target site.

pageElementType - the element type.

elementId - the element id.

clear

public void clear()

Removes all stored data.

clear

public void clear(String workspace,
                  String site)

Removes all data associated with a JCR workspace and a site.

Parameters:

workspace - the current JCR workspace. If null, means all workspaces.

site - the current site.

clear

public void clear(String workspace,
                  String site,
                  String pageElementType)

Removes all data associated with a JCR workspace, a site and a given element type.

Parameters:

workspace - the current JCR workspace.

site - the current site.

pageElementType - the element type.

dispose

public void dispose()

Specified by:

dispose in interface Disposable

isEnabled

protected boolean isEnabled()

Test if the cache is enabled.

Returns:

true if the cache is enabled, false otherwise.

incrementCount

protected void incrementCount(Map<String,Map<String,Map<String,AtomicInteger>>> countMap,
                              String workspace,
                              String siteName,
                              String pageElementType)

Add a hit count for a workspace, site and page element type.

Parameters:

countMap - the map to fill.

workspace - the workspace.

siteName - the site name.

pageElementType - the page element type.

getCount

protected int getCount(Map<String,Map<String,Map<String,AtomicInteger>>> countMap,
                       String workspace,
                       String siteName,
                       String pageElementType)

Get a hit or miss count for a workspace, site and page element type.

Parameters:

countMap - the count map.

workspace - the workspace.

siteName - the site name.

pageElementType - the page element type.

Returns:

the count.

logAndResetHitCount

protected void logAndResetHitCount()

Reset the hit count after logging the old value.

logAndResetHitCount

protected void logAndResetHitCount(String workspace,
                                   String siteName)

Reset the hit count after logging the old value.

Parameters:

workspace - the workspace.

siteName - the site name.

logAndResetHitCount

protected void logAndResetHitCount(String workspace,
                                   String siteName,
                                   String pageElementType)

Reset the hit count after logging the old value.

Parameters:

workspace - the workspace.

siteName - the site name.

pageElementType - the page element type.

logAndResetHitCount

protected void logAndResetHitCount(String workspace,
                                   String siteName,
                                   String pageElementType,
                                   AtomicInteger hitCount)

Reset the hit count after logging the old value.

Parameters:

workspace - the workspace.

siteName - the site name.

pageElementType - the page element type.

hitCount - the old hit count.

logFullHitCount

protected void logFullHitCount(String workspace,
                               String siteName,
                               String pageElementType)

Log the full hit and miss count for a given workspace, site and page element type.

Parameters:

workspace - the workspace.

siteName - the site name.

pageElementType - the page element type.