Package org.ametys.plugins.odfweb.observation

Class InvalidateCacheOnContentValidationOrUnpublishingObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfweb.observation.AbstractODFObserver

org.ametys.plugins.odfweb.observation.InvalidateCacheOnContentValidationOrUnpublishingObserver

All Implemented Interfaces:

Observer, LogEnabled, Contextualizable, Serviceable

Direct Known Subclasses:

InvalidateCacheOnSkillsExclusionChangedObserver

public class InvalidateCacheOnContentValidationOrUnpublishingObserver
extends AbstractODFObserver

Observer for observing content validation or tagging in order to invalidate cache on front-office.

Field Summary

Fields

Modifier and Type	Field	Description
protected CacheInvalidationPolicy	_cachePolicy	Cache invalidation policy

Fields inherited from class org.ametys.plugins.odfweb.observation.AbstractODFObserver

_cocoonContext, _context, _odfHelper, _resolver

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
InvalidateCacheOnContentValidationOrUnpublishingObserver()

Method Summary

Modifier and Type	Method	Description
protected void	_internalObserve(Event event, Map<String,Object> transientVars, Page odfRootPage, Set<Program> rootPrograms, SubProgram subProgram, Course course)	Do the actual work.
protected void	_invalidate(Site site, Content content)	Invalidate content cache
protected String	_workspaceToUse()	The workspace to use.
int	getPriority(Event event)	Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
void	service(ServiceManager serviceManager)
boolean	supports(Event event)	Checks if the event is supported.

Methods inherited from class org.ametys.plugins.odfweb.observation.AbstractODFObserver

_getContentArgument, _getCourse, _getODFRootPages, _getPrograms, _getSubProgram, contextualize, observe

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

_cachePolicy

protected CacheInvalidationPolicy _cachePolicy

Cache invalidation policy

Constructor Details

InvalidateCacheOnContentValidationOrUnpublishingObserver

public InvalidateCacheOnContentValidationOrUnpublishingObserver()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractODFObserver

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.

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.

Parameters:

event - the event.

Returns:

the priority where 0 the max priority and Integer.MAX_VALUE the min priority.

_workspaceToUse

protected String _workspaceToUse()

Description copied from class: AbstractODFObserver

The workspace to use. Default to default, override this method to work on a different workspace

Overrides:

_workspaceToUse in class AbstractODFObserver

Returns:

The workspace to use

_internalObserve

protected void _internalObserve(Event event,
 Map<String,Object> transientVars,
 Page odfRootPage,
 Set<Program> rootPrograms,
 SubProgram subProgram,
 Course course)
                         throws Exception

Description copied from class: AbstractODFObserver

Do the actual work.

Specified by:

_internalObserve in class AbstractODFObserver

Parameters:

event - the event.

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

odfRootPage - the Page holding the virtual factory.

rootPrograms - the root programs.

subProgram - The subprogram. Can be null

course - The course. Can be null.

Throws:

Exception - if an error occured

_invalidate

protected void _invalidate(Site site,
 Content content)

Invalidate content cache

Parameters:

site - the site

content - the content