Package org.ametys.cms.trash.observer

Class AbstractTrashElementIndexingObserver

java.lang.Object

org.ametys.cms.trash.observer.AbstractTrashElementIndexingObserver

All Implemented Interfaces:

IndexingObserver, AsyncObserver, Observer, Prioritizable, Supporter<Event>, Serviceable

Direct Known Subclasses:

IndexTrashElementObserver, UnindexTrashElementObserver

public abstract class AbstractTrashElementIndexingObserver
extends Object
implements AsyncObserver, IndexingObserver, Serviceable

Abstract class to define observers on trash elements.

Field Summary

Fields

Modifier and Type	Field	Description
protected SolrIndexer	_solrIndexer	The Solr indexer

Fields inherited from interface org.ametys.cms.indexing.IndexingObserver

INDEXING_OBSERVER

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractTrashElementIndexingObserver()

Method Summary

Modifier and Type	Method	Description
int	getPriority()	Get the priority for the component.
protected abstract Set<String>	getSupportedEvents()	Get the supported events id by the observer.
protected String	getTrashElementId(Event event)	Get the trash element identifier from the event arguments.
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
protected abstract void	processTrashElement(String trashElementId)	Observe and process the trash element
void	service(ServiceManager serviceManager)
boolean	supports(Event event)	Check if an element is supported

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.core.observation.AsyncObserver

parallelizable

Methods inherited from interface org.ametys.cms.indexing.IndexingObserver

getTraits

Field Details

_solrIndexer

protected SolrIndexer _solrIndexer

The Solr indexer

Constructor Details

AbstractTrashElementIndexingObserver

public AbstractTrashElementIndexingObserver()

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: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<Event>

Parameters:

event - The element

Returns:

true if the element is supported, false otherwise

getSupportedEvents

protected abstract Set<String> getSupportedEvents()

Get the supported events id by the observer.

Returns:

the supported events

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the 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.

processTrashElement

protected abstract void processTrashElement(String trashElementId)
                                     throws Exception

Observe and process the trash element

Parameters:

trashElementId - the trash element identifier

Throws:

Exception - if an exception occurs

getTrashElementId

protected String getTrashElementId(Event event)

Get the trash element identifier from the event arguments.

Parameters:

event - The event

Returns:

the trash element identifier