Package org.ametys.web.cache.service

Class IsolatedServiceCachePolicy

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.cache.service.IsolatedServiceCachePolicy

All Implemented Interfaces:

PageElementCachePolicy, Configurable, LogEnabled

public class IsolatedServiceCachePolicy
extends AbstractLogEnabled
implements PageElementCachePolicy, Configurable

PageElementCachePolicy for isolated services (services which don't display modifiable data from other objects, such as Iframe service).
The shouldClearCache method always return PolicyResult.KEEP.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.web.cache.pageelement.PageElementCachePolicy

PageElementCachePolicy.PolicyResult

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	_types	The handled types.

Constructor Summary

Constructors

Constructor	Description
IsolatedServiceCachePolicy()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
Set<String>	getPageElementTypes()	Returns the types of the associated page elements.
final PageElementCachePolicy.PolicyResult	shouldClearCache(String workspace, Site site, String pageElementType, String elementId, Event event)	Second pass of event processing, at the Page level. This method is only called if the first pass resulted with NEED_MORE_INFORMATION.
final PageElementCachePolicy.PolicyResult	shouldClearCache(String workspace, Site site, String pageElementType, Event event)	First pass of event processing, at the type level. Returning NEED_MORE_INFORMATION eventually leads to the second pass, which is more precise, and also depends on a particular element, but is more costly to compute. Returning null means that this policy declares itself as not concerned by the current event.

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 Details

_types

protected Set<String> _types

The handled types.

Constructor Details

IsolatedServiceCachePolicy

public IsolatedServiceCachePolicy()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getPageElementTypes

public Set<String> getPageElementTypes()

Description copied from interface: PageElementCachePolicy

Returns the types of the associated page elements.

Specified by:

getPageElementTypes in interface PageElementCachePolicy

Returns:

the types of the associated page elements.

shouldClearCache

public final PageElementCachePolicy.PolicyResult shouldClearCache(String workspace,
 Site site,
 String pageElementType,
 Event event)

Description copied from interface: PageElementCachePolicy

First pass of event processing, at the type level.
Returning NEED_MORE_INFORMATION eventually leads to the second pass, which is more precise, and also depends on a particular element, but is more costly to compute.
Returning null means that this policy declares itself as not concerned by the current event.

Specified by:

shouldClearCache in interface PageElementCachePolicy

Parameters:

workspace - the current JCR workspace.

site - the current site.

pageElementType - the page element type.

event - the current event.

Returns:

the policy result or null if this policy declares itself as not concerned.

shouldClearCache

public final PageElementCachePolicy.PolicyResult shouldClearCache(String workspace,
 Site site,
 String pageElementType,
 String elementId,
 Event event)

Description copied from interface: PageElementCachePolicy

Second pass of event processing, at the Page level.
This method is only called if the first pass resulted with NEED_MORE_INFORMATION. If this method also returns NEED_MORE_INFORMATION, it will be interpreted as REMOVE.

Specified by:

shouldClearCache in interface PageElementCachePolicy

Parameters:

workspace - the current JCR workspace.

site - the current site.

pageElementType - the page element type.

elementId - the current element id.

event - the current event.

Returns:

the policy result.