Package org.ametys.plugins.odfweb.observation

Class ClearODFPageCacheObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfweb.observation.ClearODFPageCacheObserver

All Implemented Interfaces:

Observer, LogEnabled, Contextualizable, Serviceable

public class ClearODFPageCacheObserver
extends AbstractLogEnabled
implements Observer, Serviceable, Contextualizable

Clear ODF caches when page ODF root page has changed

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	Avalon context
protected ODFPageCache	_odfPageCache	The ODF page cache
protected OdfPageHandler	_odfPageHandler	The ODF root page handler.
protected OdfPageResolver	_odfPageResolver	Odf page resolver
protected AmetysObjectResolver	_resolver	Ametys object resolver
protected SiteManager	_siteManager	Site manager

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ClearODFPageCacheObserver()

Method Summary

Modifier and Type	Method	Description
protected void	_clearCache(OrgUnit orgUnit)	Clear the cache when necessary in case of an orgUnit
protected void	_clearCache(Program program)	Clear the cache when necessary in case of a program
protected void	_clearCache(Page page)	Clear the cache when necessary in case of a page
protected void	_clearCache(Site site)	Clear the cache when necessary in case of a site
private AmetysObjectIterable<Page>	_getOdfRootPages()
void	contextualize(Context context)
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 manager)
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 Detail

_odfPageHandler

protected OdfPageHandler _odfPageHandler

The ODF root page handler.

_odfPageCache

protected ODFPageCache _odfPageCache

The ODF page cache

_siteManager

protected SiteManager _siteManager

Site manager

_odfPageResolver

protected OdfPageResolver _odfPageResolver

Odf page resolver

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

_context

protected Context _context

Avalon context

Constructor Detail

ClearODFPageCacheObserver

public ClearODFPageCacheObserver()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

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.

_clearCache

protected void _clearCache(Page page)

Clear the cache when necessary in case of a page

Parameters:

page - The page

_clearCache

protected void _clearCache(Program program)

Clear the cache when necessary in case of a program

Parameters:

program - The program

_getOdfRootPages

private AmetysObjectIterable<Page> _getOdfRootPages()

_clearCache

protected void _clearCache(OrgUnit orgUnit)

Clear the cache when necessary in case of an orgUnit

Parameters:

orgUnit - The orgUnit

_clearCache

protected void _clearCache(Site site)

Clear the cache when necessary in case of a site

Parameters:

site - The site