Package org.ametys.plugins.workspaces.members.observers

Class AbstractMemberObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.members.observers.AbstractMemberObserver

All Implemented Interfaces:

AsyncObserver, Observer, LogEnabled, Serviceable

Direct Known Subclasses:

IndexMemberObserver, InvalidateCacheOnMemberUpdatedObserver, InvalidateZoneItemCacheOnMemberUpdatedObserver

public abstract class AbstractMemberObserver
extends AbstractLogEnabled
implements AsyncObserver, Serviceable

Abstract observer for member update

Field Summary

Fields

Modifier and Type	Field	Description
protected GroupManager	_groupManager	The group manager
protected ProjectManager	_projectManager	The project manager
protected SiteManager	_siteManager	The site manager
protected ServiceManager	_smanager	The service manager
protected UserDirectoryHelper	_userDirectoryHelper	The user directory helper

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractMemberObserver()

Method Summary

Modifier and Type	Method	Description
protected abstract void	_internalObserve(Event event, List<Content> userContents)	Observes the event with access to the user contents
int	getPriority(Event event)	Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
protected List<Content>	getUserContents(Set<UserIdentity> users)	Get the user contents associated to user identities
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager smanager)
boolean	supports(Event event)	Checks if the event is supported.

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

parallelizable

Field Detail

_smanager

protected ServiceManager _smanager

The service manager

_groupManager

protected GroupManager _groupManager

The group manager

_userDirectoryHelper

protected UserDirectoryHelper _userDirectoryHelper

The user directory helper

_siteManager

protected SiteManager _siteManager

The site manager

_projectManager

protected ProjectManager _projectManager

The project manager

Constructor Detail

AbstractMemberObserver

public AbstractMemberObserver()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

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.

Specified by:

supports in interface Observer

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

Parameters:

event - the event.

Returns:

the priority where 0 the max priority and Integer.MAX_VALUE the min 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,
                                         List<Content> userContents)
                                  throws Exception

Observes the event with access to the user contents

Parameters:

event - the event.

userContents - the user contents

Throws:

Exception - if an error occurs.

getUserContents

protected List<Content> getUserContents(Set<UserIdentity> users)

Get the user contents associated to user identities

Parameters:

users - the users

Returns:

the user contents