Class AbstractInitializeProjectObserver
- java.lang.Object
-
- org.ametys.runtime.plugin.component.AbstractLogEnabled
-
- org.ametys.plugins.workspaces.project.observers.AbstractInitializeProjectObserver
-
- All Implemented Interfaces:
Observer
,LogEnabled
,PluginAware
,Serviceable
- Direct Known Subclasses:
InitializeCalendarObserver
,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
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract void
doObserve(Event event, Map<String,Object> transientVars, Site site, Project project)
This method will be called byObserver.observe(Event, Map)
when there is a project on this siteint
getPriority(Event event)
Retrieves the priority to observe this event.
This can be used to process a supported event before others observers.void
observe(Event event, Map<String,Object> transientVars)
Observes an event.void
service(ServiceManager manager)
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.runtime.plugin.component.PluginAware
setPluginInfo
-
-
-
-
Field Detail
-
_projectManager
protected ProjectManager _projectManager
Project Manager
-
-
Constructor Detail
-
AbstractInitializeProjectObserver
public AbstractInitializeProjectObserver()
-
-
Method Detail
-
service
public void service(ServiceManager manager) throws ServiceException
- Specified by:
service
in interfaceServiceable
- 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.
-
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 interfaceObserver
- 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 interfaceObserver
- 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 byObserver.observe(Event, Map)
when there is a project on this site- Parameters:
event
- the eventtransientVars
- transientVars passed from one Observer to another when processing a single Event. This may allow optimizations between observers.site
- the site impactedproject
- the project impacted- Throws:
Exception
- something went wrong
-
-