Package org.ametys.odf.observation

Class AbstractCDMFRObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.observation.AbstractCDMFRObserver

All Implemented Interfaces:

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

Direct Known Subclasses:

DepositCDMFRObserver, SendCDMFRObserver

public abstract class AbstractCDMFRObserver
extends AbstractLogEnabled
implements Observer, Serviceable

Abstract observer to handle CDMFR file when a odf content is validated

Field Summary

Fields

Modifier and Type	Field	Description
protected CDMFRHandler	_cdmfrHandler	The CDM-fr handler

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractCDMFRObserver()

Method Summary

Modifier and Type	Method	Description
protected abstract void	doObserve(Set<Program> programs)	Do observe for CDM-fr observer
int	getPriority()	Get the priority for the component.
protected Set<Program>	getRelatedPrograms(Content content)	Get the related programs from the content
protected abstract boolean	isActive()	true if the observer is active
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

Field Details

_cdmfrHandler

protected CDMFRHandler _cdmfrHandler

The CDM-fr handler

Constructor Details

AbstractCDMFRObserver

public AbstractCDMFRObserver()

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.

getRelatedPrograms

protected Set<Program> getRelatedPrograms(Content content)

Get the related programs from the content

Parameters:

content - the content

Returns:

the related program

isActive

protected abstract boolean isActive()

true if the observer is active

Returns:

true if the observer is active

doObserve

protected abstract void doObserve(Set<Program> programs)

Do observe for CDM-fr observer

Parameters:

programs - the concerned programs