Package org.ametys.plugins.ugc.observation

Class UGCContentValidatedObserver

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.ugc.observation.AbstractUGCContentObserver

org.ametys.plugins.ugc.observation.UGCContentValidatedObserver

All Implemented Interfaces:

Observer, Configurable, LogEnabled, Serviceable

public class UGCContentValidatedObserver
extends AbstractUGCContentObserver

Observer for observing UGC content first validation in order to send notification mail to creator.

Field Summary

Fields inherited from class org.ametys.plugins.ugc.observation.AbstractUGCContentObserver

_bodyI18nKey, _cTypeHelper, _i18nUtils, _subjectI18nKey

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
UGCContentValidatedObserver()

Method Summary

Modifier and Type	Method	Description
int	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.
boolean	supports(Event event)	Checks if the event is supported.

Methods inherited from class org.ametys.plugins.ugc.observation.AbstractUGCContentObserver

configure, getBodyI18nParams, getMailBody, getMailSubject, getSubjectI18nParams, sendMailToUGCAuthor, service

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UGCContentValidatedObserver

public UGCContentValidatedObserver()

Method Detail

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.

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

Overrides:

getPriority in class AbstractUGCContentObserver

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.

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.