org.ametys.plugins.userdirectory.observation

Class AbstractUserObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.userdirectory.observation.AbstractUserObserver

All Implemented Interfaces:

Observer, LogEnabled, Contextualizable, Serviceable

Direct Known Subclasses:

AbstractSolrUserObserver, InvalidateCacheOnContentValidationObserver, InvalidateZoneItemCacheOnUserContentModificationObserver, InvalidateZoneItemCacheOnUserContentValidationObserver, UserContentCacheObserver

public abstract class AbstractUserObserver
extends AbstractLogEnabled
implements Observer, Serviceable, Contextualizable

Abstract Observer for observing validation of User content.

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	_cocoonContext Cocoon context.
protected ContentTypesHelper	_contentTypeHelper The content type helper
protected Context	_context The context.
protected AmetysObjectResolver	_resolver Ametys object resolver.

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractUserObserver()

Method Summary

Modifier and Type	Method and Description
protected Content	_getTarget(Event event) Retrieve the target of the observer
protected Content	_getUserContent(Event event) Get the target user content
protected AmetysObjectIterable<Page>	_getUserDirectoryRootPages() Get the user directory root pages
protected abstract void	_internalObserve(Event event, Page rootUsersPage, Content userContent) Do the actual work.
void	contextualize(Context context)
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

getPriority, supports

Field Detail

_context

protected Context _context

The context.

_cocoonContext

protected Context _cocoonContext

Cocoon context.

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver.

_contentTypeHelper

protected ContentTypesHelper _contentTypeHelper

The content type helper

Constructor Detail

AbstractUserObserver

public AbstractUserObserver()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

observe

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

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.

_internalObserve

protected abstract void _internalObserve(Event event,
                                         Page rootUsersPage,
                                         Content userContent)

Do the actual work.

Parameters:

event - the observation event.

rootUsersPage - the page holding the virtual user pages

userContent - a list containing all impacted user contents.

_getUserDirectoryRootPages

protected AmetysObjectIterable<Page> _getUserDirectoryRootPages()

Get the user directory root pages

Returns:

the user directory root pages

_getTarget

protected Content _getTarget(Event event)
                      throws Exception

Retrieve the target of the observer

Parameters:

event - The event

Returns:

The target

Throws:

Exception - if failed to get content

_getUserContent

protected Content _getUserContent(Event event)
                           throws Exception

Get the target user content

Parameters:

event - the event

Returns:

the target user content or null if content if not the user content

Throws:

Exception - if failed to get content