Package org.ametys.web.synchronization

Class AbstractSynchronizeObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.synchronization.AbstractSynchronizeObserver

All Implemented Interfaces:

Observer, LogEnabled, Prioritizable, Supporter<Event>, Serviceable

Direct Known Subclasses:

AbstractSynchronizePageObserver, InvalidateCacheOnQueryChangesObserver, SkillsDisplayObserver, SynchronizeACLObserver, SynchronizeContentAdditionObserver, SynchronizeContentCommentedObserver, SynchronizeContentDeletionObserver, SynchronizeContentPrivacyChangeObserver, SynchronizeContentReactionObserver, SynchronizeContentTaggedObserver, SynchronizeContentUnpublishObserver, SynchronizeContentValidationObserver, SynchronizedContentTranslatedObserver, SynchronizePageAttachmentsObserver, SynchronizePageDeletionObserver, SynchronizePageMoveObserver, SynchronizeRobotsChangeObserver, SynchronizeSiteChangeObserver, SynchronizeSitemapAdditionObserver, SynchronizeSitemapChangeObserver, SynchronizeSitemapZonesObserver, SynchronizeSiteMoveObserver, SynchronizeSiteOrSitemapDeletionObserver

public abstract class AbstractSynchronizeObserver
extends AbstractLogEnabled
implements Observer, Serviceable

Abstract Observer for synchronizing the workspace live.

A lock is used for write access to the live session in order to prevent errors from a parallel full synchronization or observer.

Field Summary

Fields

Modifier and Type	Field	Description
protected LiveAccessManager	_liveAccessManager	Preview access manager.
protected javax.jcr.Repository	_repository	JCR repository.
protected SynchronizeComponent	_synchronizeComponent	The SynchronizeComponent

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractSynchronizeObserver()

Method Summary

Modifier and Type	Method	Description
protected abstract void	_internalObserve(Event event, javax.jcr.Session liveSession)	Observes the event with access to the live workspace.
int	getPriority()	Get the priority for the component.
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager manager)

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

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

getTraits

Methods inherited from interface org.ametys.runtime.plugin.component.Supporter

supports

Field Details

_repository

protected javax.jcr.Repository _repository

JCR repository.

_liveAccessManager

protected LiveAccessManager _liveAccessManager

Preview access manager.

_synchronizeComponent

protected SynchronizeComponent _synchronizeComponent

The SynchronizeComponent

Constructor Details

AbstractSynchronizeObserver

public AbstractSynchronizeObserver()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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.

_internalObserve

protected abstract void _internalObserve(Event event,
 javax.jcr.Session liveSession)
                                  throws javax.jcr.RepositoryException

Observes the event with access to the live workspace.

Parameters:

event - the event.

liveSession - the session to the live workspace.

Throws:

javax.jcr.RepositoryException - if an error occurs.