Package org.ametys.plugins.odfweb.observation

Class InvalidateCacheOnOrgunitChangedObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfweb.observation.InvalidateCacheOnOrgunitChangedObserver

All Implemented Interfaces:

Observer, LogEnabled, Serviceable

public class InvalidateCacheOnOrgunitChangedObserver
extends AbstractLogEnabled
implements Observer, Serviceable

Observer for observing OrgUnit validation, unpublishing, deletion or moving (with event ObservationConstants.EVENT_CONTENT_MODIFIED, which will lead to sometimes invalidating cache whereas it is not necessary) in order to invalidate cache on front-office.

Field Summary

Fields

Modifier and Type	Field	Description
protected CacheInvalidationPolicy	_cachePolicy	Cache invalidation policy
protected OdfPageHandler	_odfPageHandler	The ODF page handler.
protected SiteManager	_siteManager	The site manager.

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
InvalidateCacheOnOrgunitChangedObserver()

Method Summary

Modifier and Type	Method	Description
int	getPriority(Event event)	Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager serviceManager)
boolean	supports(Event event)	Checks if the event is supported.

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

Field Details

_siteManager

protected SiteManager _siteManager

The site manager.

_odfPageHandler

protected OdfPageHandler _odfPageHandler

The ODF page handler.

_cachePolicy

protected CacheInvalidationPolicy _cachePolicy

Cache invalidation policy

Constructor Details

InvalidateCacheOnOrgunitChangedObserver

public InvalidateCacheOnOrgunitChangedObserver()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

supports

public boolean supports(Event event)

Description copied from interface: Observer

Checks if the event is supported. If true, the observe(Event) method will be called.

Specified by:

supports in interface Observer

Parameters:

event - the event.

Returns:

true for observing this event, false otherwise.

getPriority

public int getPriority(Event event)

Description copied from interface: Observer

Retrieves the priority to observe this event.
This can be used to process a supported event before others observers.

Specified by:

getPriority in interface Observer

Parameters:

event - the event.

Returns:

the priority where 0 the max priority and Integer.MAX_VALUE the min 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.