org.ametys.plugins.odfweb.observation.solr

Class AbstractSolrOrgUnitObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.indexing.observation.AbstractSolrObserver

org.ametys.plugins.odfweb.observation.solr.AbstractSolrOrgUnitObserver

All Implemented Interfaces:

Observer, LogEnabled, Serviceable

Direct Known Subclasses:

SolrOrgUnitChangedPart1Observer, SolrOrgUnitChangedPart2Observer

public abstract class AbstractSolrOrgUnitObserver
extends AbstractSolrObserver

Observer for observing orgunit modifications in order to synchronize Solr index.

Field Summary

Fields

Modifier and Type	Field and Description
protected OdfPageHandler	_odfPageHandler The ODF page handler.
protected OdfProgramRestrictionManager	_odfProgramRestrictionManager Odf program restriction manager
protected SiteConfigurationExtensionPoint	_siteConf The site configuration.
protected SiteManager	_siteManager The site manager.

Fields inherited from class org.ametys.web.indexing.observation.AbstractSolrObserver

_resolver, _siteIndexer, _solrIndexer, _solrPageIndexer

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractSolrOrgUnitObserver()

Method Summary

Modifier and Type	Method and Description
protected abstract String[]	_supportedEventIds() Gets the supported event ids for this Observer to look for the OrgUnits
protected abstract void	_updateIndex(Page odfRootPage) Update the index from the observed event.
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.web.indexing.observation.AbstractSolrObserver

_updateIndexReferencingPages, getPriority

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

_siteManager

protected SiteManager _siteManager

The site manager.

_siteConf

protected SiteConfigurationExtensionPoint _siteConf

The site configuration.

_odfPageHandler

protected OdfPageHandler _odfPageHandler

The ODF page handler.

_odfProgramRestrictionManager

protected OdfProgramRestrictionManager _odfProgramRestrictionManager

Odf program restriction manager

Constructor Detail

AbstractSolrOrgUnitObserver

public AbstractSolrOrgUnitObserver()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSolrObserver

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.

_supportedEventIds

protected abstract String[] _supportedEventIds()

Gets the supported event ids for this Observer to look for the OrgUnits

Returns:

the supported event ids for this Observer

observe

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

Description copied from interface: Observer

Observes an event.

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.

_updateIndex

protected abstract void _updateIndex(Page odfRootPage)
                              throws Exception

Update the index from the observed event.

Parameters:

odfRootPage - the odf root page

Throws:

Exception - if an error occurs.