Package org.ametys.plugins.odfweb.observation.solr

Class UnindexProgramObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfweb.observation.AbstractODFObserver

org.ametys.plugins.odfweb.observation.solr.AbstractSolrODFObserver

org.ametys.plugins.odfweb.observation.solr.UnindexProgramObserver

All Implemented Interfaces:

Observer, LogEnabled, Contextualizable, Serviceable

public class UnindexProgramObserver
extends AbstractSolrODFObserver

Observes ODF Program deletion or unpublishing in order to synchronize the Solr index.

Field Summary

Fields inherited from class org.ametys.plugins.odfweb.observation.solr.AbstractSolrODFObserver

_odfPageResolver, _solrIndexer, _solrPageIndexer

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
UnindexProgramObserver()

Method Summary

Modifier and Type	Method	Description
protected void	_updateIndex(Event event, Map<String,Object> transientVars, Page odfRootPage, Program program, SubProgram subProgram, Course course)	Update the index from the observed event.
int	getPriority(Event event)	Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
boolean	supports(Event event)	Checks if the event is supported.

Methods inherited from class org.ametys.plugins.odfweb.observation.solr.AbstractSolrODFObserver

_internalObserve, service

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

_getContentArgument, _getCourse, _getODFRootPages, _getPrograms, _getSubProgram, _workspaceToUse, 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

Constructor Detail

UnindexProgramObserver

public UnindexProgramObserver()

Method Detail

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.

Specified by:

getPriority in interface Observer

Overrides:

getPriority in class AbstractSolrODFObserver

Parameters:

event - the event.

Returns:

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

_updateIndex

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

Description copied from class: AbstractSolrODFObserver

Update the index from the observed event.

Specified by:

_updateIndex in class AbstractSolrODFObserver

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 odf root page

program - the target program

subProgram - The subprogram. Can be null

course - the course. Can be null.

Throws:

Exception - if an error occurs.