Package org.ametys.cms.trash.observer

Class AbstractAmetysObjectAddedObserver<T extends TrashableAmetysObject>

java.lang.Object

org.ametys.cms.trash.observer.AbstractAmetysObjectAddedObserver<T>

Type Parameters:

T - The type of the restored object

All Implemented Interfaces:

Observer, Prioritizable, Supporter<Event>, Serviceable

Direct Known Subclasses:

ContentAddedObserver, PageAddedObserver, ResourceAddedObserver, WebContentAddedObserver

public abstract class AbstractAmetysObjectAddedObserver<T extends TrashableAmetysObject>
extends Object
implements Observer, Serviceable

Abstract observer to send added notification of each object restored by the trash.

Field Summary

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractAmetysObjectAddedObserver()

Method Summary

Modifier and Type	Method	Description
protected abstract String	getEventId()	Get event identifier to notify.
protected abstract Map<String,Object>	getEventParams(T ametysObject)	Get the event params to send in the notification.
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 java.lang.Object

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

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

getTraits

Constructor Details

AbstractAmetysObjectAddedObserver

public AbstractAmetysObjectAddedObserver()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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

supports

public boolean supports(Event event)

Description copied from interface: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<T extends TrashableAmetysObject>

Parameters:

event - The element

Returns:

true if the element is supported, false otherwise

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.

getEventId

protected abstract String getEventId()

Get event identifier to notify.

Returns:

the event id

getEventParams

protected abstract Map<String,Object> getEventParams(T ametysObject)

Get the event params to send in the notification.

Parameters:

ametysObject - The Ametys object on which the event is send

Returns:

the event params as a map