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
(package private) class	ObservationManager.AbstractAsyncObserve	Runnable to be used for asynchronous calls
(package private) static class	ObservationManager.AsyncObserveThreadFactory	Thread factory for async observers.
(package private) class	ObservationManager.NonParallelAsyncObserve	Runnable for non parallel observers
(package private) class	ObservationManager.ParallelAsyncObserve	Runnable for parallel observers

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__ADDITIONAL_ARGS_TO_PASS_BY_EVENT_ID_REQUEST_ATTR_NAME
private static org.slf4j.Logger	__ALL_EVENTS_LOGGER
private static String	__CURRENT_FUTURES_REQUEST_ATTR_NAME
private static ExecutorService	__PARALLEL_THREAD_EXECUTOR	The executor service managing the thread pool of asynchronous observers allowed to run in parallel.
private static ExecutorService	__SINGLE_THREAD_EXECUTOR	The executor service managing the single thread pool.
private Context	_avalonContext
protected Context	_context	Cocoon context
protected ServiceManager	_manager	Service manager
private ObserverExtensionPoint	_observerExtPt
private Collection<Observer>	_registeredObservers
static String	ROLE	Avalon ROLE.

Constructor Summary

Constructors

Constructor	Description
ObservationManager()

Method Summary

Modifier and Type	Method	Description
private void	_addSupportedObserver(List<Observer> supportedObservers, Observer observer, Event event)
private void	_asyncObserve(Collection<AsyncObserver> parallelObservers, List<AsyncObserver> nonParallelObservers, Event event, Map<String,Object> transientVars, List<Future> result)	Async observe through a thread pool
private List<Future>	_getFuturesForRequest()
protected void	_observesEvent(Event event, List<Observer> supportedObservers, List<Future> result)	Observes the event
private void	_putAdditionalArgs(Event 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<Future>	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 Detail

ROLE

public static final String ROLE

Avalon ROLE.

__CURRENT_FUTURES_REQUEST_ATTR_NAME

private static final String __CURRENT_FUTURES_REQUEST_ATTR_NAME

__ADDITIONAL_ARGS_TO_PASS_BY_EVENT_ID_REQUEST_ATTR_NAME

private static final String __ADDITIONAL_ARGS_TO_PASS_BY_EVENT_ID_REQUEST_ATTR_NAME

__ALL_EVENTS_LOGGER

private static final org.slf4j.Logger __ALL_EVENTS_LOGGER

__SINGLE_THREAD_EXECUTOR

private static ExecutorService __SINGLE_THREAD_EXECUTOR

The executor service managing the single thread pool. This threads is used to run non-parallelizable observers.

__PARALLEL_THREAD_EXECUTOR

private static ExecutorService __PARALLEL_THREAD_EXECUTOR

The executor service managing the thread pool of asynchronous observers allowed to run in parallel.

_context

protected Context _context

Cocoon context

_manager

protected ServiceManager _manager

Service manager

_avalonContext

private Context _avalonContext

_observerExtPt

private ObserverExtensionPoint _observerExtPt

_registeredObservers

private Collection<Observer> _registeredObservers

Constructor Detail

ObservationManager

public ObservationManager()

Method Detail

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

_addSupportedObserver

private void _addSupportedObserver(List<Observer> supportedObservers,
                                   Observer observer,
                                   Event event)

getFuturesForRequest

public List<Future> 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.

_getFuturesForRequest

private List<Future> _getFuturesForRequest()
                                    throws CascadingRuntimeException

Throws:

CascadingRuntimeException

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

_putAdditionalArgs

private void _putAdditionalArgs(Event event)

_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

_asyncObserve

private void _asyncObserve(Collection<AsyncObserver> parallelObservers,
                           List<AsyncObserver> nonParallelObservers,
                           Event event,
                           Map<String,Object> transientVars,
                           List<Future> result)

Async observe through a thread pool

Parameters:

parallelObservers - parallelizable asynchronous observers

nonParallelObservers - non parallelizable asynchronous observers

event - The event to observe

transientVars - The observer transient vars

result - The future results

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.