Package org.ametys.core.observation

Class ObservationManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.core.observation.ObservationManager

All Implemented Interfaces:

Disposable, Component, Contextualizable, LogEnabled, Serviceable

public class ObservationManager
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable, Disposable

Manager for dispatching Event instances to Observers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ObservationManager.ObserverFuture	Store a future and the traits of the observer that it will execute

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	Cocoon context
protected ServiceManager	_manager	Service manager
static final String	ROLE	Avalon ROLE.

Constructor Summary

Constructors

Constructor	Description
ObservationManager()

Method Summary

Modifier and Type	Method	Description
protected void	_observesEvent(Event event, List<Observer> supportedObservers, List<Future> result)	Observes the event
void	addArgumentForEvents(String[] eventIds, String argName, Object argValue)	For all events of the given event id which will be notified during the current request, add an additional argument
void	contextualize(Context context)
void	dispose()
List<ObservationManager.ObserverFuture>	getFuturesForRequest()	Gets all the Futures of all the AsyncObservers notified by the call to notify(Event) during the current request.
List<Future>	notify(Event event)	Notify of a event which will be dispatch to registered observers.
void	registerObserver(Observer observer)	Registers an Observer.
void	removeArgumentForEvents(String[] eventIds, String argName)	For all events of the given event id which will be notified during the current request, removes the additional argument with the given name which was added with the addArgumentForEvents(String[], String, Object) method.
void	service(ServiceManager manager)
void	unregisterObserver(Observer observer)	Unregisters an Observer.

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

Field Details

ROLE

public static final String ROLE

Avalon ROLE.

_context

protected Context _context

Cocoon context

_manager

protected ServiceManager _manager

Service manager

Constructor Details

ObservationManager

public ObservationManager()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

notify

public List<Future> notify(Event event)

Notify of a event which will be dispatch to registered observers.

Parameters:

event - the event to notify.

Returns:

The Future objects of the asynchronous observers

getFuturesForRequest

public List<ObservationManager.ObserverFuture> getFuturesForRequest()

Gets all the Futures of all the AsyncObservers notified by the call to notify(Event) during the current request.
This can be useful to call Future.get() in order to ensure all AsyncObservers notified by the current request have finished to work.

Returns:

the Futures of the notified observers during the current request.

addArgumentForEvents

public void addArgumentForEvents(String[] eventIds,
 String argName,
 Object argValue)

For all events of the given event id which will be notified during the current request, add an additional argument

Parameters:

eventIds - The event ids

argName - The name of the additional argument

argValue - The value of the additional argument

removeArgumentForEvents

public void removeArgumentForEvents(String[] eventIds,
 String argName)

For all events of the given event id which will be notified during the current request, removes the additional argument with the given name which was added with the addArgumentForEvents(String[], String, Object) method.

Parameters:

eventIds - The event ids

argName - The name of the additional argument to remove

_observesEvent

protected void _observesEvent(Event event,
 List<Observer> supportedObservers,
 List<Future> result)
                       throws Exception

Observes the event

Parameters:

event - The event

supportedObservers - list of observers

result - The result object to fill

Throws:

Exception - on error

dispose

public void dispose()

Specified by:

dispose in interface Disposable

registerObserver

public void registerObserver(Observer observer)

Registers an Observer.

Parameters:

observer - the Observer.

unregisterObserver

public void unregisterObserver(Observer observer)

Unregisters an Observer.

Parameters:

observer - the Observer.