Package org.ametys.web.cache

Class AbstractSiteCacheObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.cache.AbstractSiteCacheObserver

All Implemented Interfaces:

Observer, LogEnabled, Prioritizable, Supporter<Event>, Serviceable

Direct Known Subclasses:

AbstractSurveyCacheObserver, InvalidateCacheOnContentCommentedObserver, InvalidateCacheOnContentDeletionObserver, InvalidateCacheOnContentPageModificationObserver, InvalidateCacheOnContentPageModificationObserver, InvalidateCacheOnContentReactionObserver, InvalidateCacheOnContentUnpublishObserver, InvalidateCacheOnContentValidationOrTaggingObserver, InvalidateCacheOnFormModifiedObserver, InvalidateCacheOnPageDeletionObserver, InvalidateCacheOnPageMinorChangeObserver, InvalidateCacheOnPageModificationObserver, InvalidateCacheOnPageMoveObserver, InvalidateCacheOnRobotsChangeObserver, InvalidateCacheOnZoneItemAdditionObserver, InvalidateCacheOnZoneItemDeletionObserver

public abstract class AbstractSiteCacheObserver
extends AbstractLogEnabled
implements Observer, Serviceable

Abstract Observer for invalidate site data.

Field Summary

Fields

Modifier and Type	Field	Description
protected CacheInvalidationPolicy	_cachePolicy	Cache invalidation policy
protected FOCommHelper	_foCommHelper	The cache helper
protected javax.jcr.Repository	_repository	JCR repository.

Fields inherited from interface org.ametys.core.observation.Observer

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractSiteCacheObserver()

Method Summary

Modifier and Type	Method	Description
protected abstract Site	_getSite(Event event)	Retrieves the site needed for accessing the front-office.
protected abstract void	_internalObserve(Event event, Site site, javax.jcr.Session liveSession)	Observes the event with access to the target site and live workspace.
int	getPriority()	Get the priority for the component.
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.core.observation.Observer

getTraits

Methods inherited from interface org.ametys.runtime.plugin.component.Supporter

supports

Field Details

_repository

protected javax.jcr.Repository _repository

JCR repository.

_cachePolicy

protected CacheInvalidationPolicy _cachePolicy

Cache invalidation policy

_foCommHelper

protected FOCommHelper _foCommHelper

The cache helper

Constructor Details

AbstractSiteCacheObserver

public AbstractSiteCacheObserver()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority

observe

public void observe(Event event,
 Map<String,Object> transientVars)
             throws Exception

Description copied from interface: Observer

Observes an event.

Specified by:

observe in interface Observer

Parameters:

event - the event.

transientVars - transientVars passed from one Observer to another when processing a single Event. This may allow optimizations between observers.

Throws:

Exception - if an error occurs. All exceptions will be logged but not propagated, as the observation mechanism should never fail.

_getSite

protected abstract Site _getSite(Event event)

Retrieves the site needed for accessing the front-office.

Parameters:

event - the event.

Returns:

the site or null if not found.

_internalObserve

protected abstract void _internalObserve(Event event,
 Site site,
 javax.jcr.Session liveSession)
                                  throws Exception

Observes the event with access to the target site and live workspace.

Parameters:

event - the event.

site - the site.

liveSession - the session to the workspace live.

Throws:

Exception - if an error occurs.