Package org.ametys.plugins.workspaces.project.observers

Class AbstractInitializeProjectObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.project.observers.AbstractInitializeProjectObserver

All Implemented Interfaces:

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

Direct Known Subclasses:

InitializeProjectSitemapObserver

public abstract class AbstractInitializeProjectObserver
extends AbstractLogEnabled
implements Observer, Serviceable, PluginAware

Abstract observer to have code executed when a sitemap is updated in a project

Field Summary

Fields

Modifier and Type	Field	Description
protected ProjectManager	_projectManager	Project Manager

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractInitializeProjectObserver()

Method Summary

Modifier and Type	Method	Description
protected abstract void	doObserve(Event event, Map<String,Object> transientVars, Site site, Project project)	This method will be called by Observer.observe(Event, Map) when there is a project on this site
int	getPriority()	Get the priority for the component.
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager manager)
boolean	supports(Event event)	Check if an element 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.Observer

getTraits

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

setPluginInfo

Field Details

_projectManager

protected ProjectManager _projectManager

Project Manager

Constructor Details

AbstractInitializeProjectObserver

public AbstractInitializeProjectObserver()

Method Details

service

public void service(ServiceManager manager)
             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

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.

doObserve

protected abstract void doObserve(Event event,
 Map<String,Object> transientVars,
 Site site,
 Project project)
                           throws Exception

This method will be called by Observer.observe(Event, Map) when there is a project on this site

Parameters:

event - the event

transientVars - transientVars passed from one Observer to another when processing a single Event. This may allow optimizations between observers.

site - the site impacted

project - the project impacted

Throws:

Exception - something went wrong