public interface EventService extends EventProducer
The service is able to run in a transactional mode where all events are recorded and fired after the transaction commits in one step as an event bundle.
To start a transaction, the framework calls the #transactionStarted()
method, and at transaction commit the
framework calls #transactionCommitted()
to fire the event bundle. Upon rollback the framework calls
#transactionRolledback()
to clean up recorded events.
Events are recorded in a thread variable so they are valid only in the current thread.
An event marked Event.isInline()
is dispatched immediately, otherwise it is recorded in a thread-based bundle
of current events. If no transaction was started, an event marked Event.isCommitEvent()
is used to flush the
event bundle to its listeners, otherwise the transaction commit does the flush.
Listeners are of two types: EventListener
notified as the event is raised and PostCommitEventListener
notified after the transaction was committed.
Modifier and Type | Method and Description |
---|---|
void |
addEventListener(EventListenerDescriptor listener)
Adds a new event listener.
|
void |
fireEvent(Event event)
Fires an event.
|
void |
fireEvent(String name,
EventContext context)
Fires an event given its name and a context.
|
void |
fireEventBundle(EventBundle event)
Fires all recorded events in a transaction.
|
void |
fireEventBundleSync(EventBundle event)
Fires an event bundle in synchronous mode.
|
EventListenerDescriptor |
getEventListener(String name)
Gets the event listener descriptor corresponding to the give name.
|
List<EventListener> |
getEventListeners()
Gets the list of the registered event listeners.
|
List<PostCommitEventListener> |
getPostCommitEventListeners()
Get the list of the registered post commit event listeners.
|
void |
removeEventListener(EventListenerDescriptor listener)
Removes an event listener.
|
void |
waitForAsyncCompletion()
Waits until all asynchronous tasks are finished.
|
void |
waitForAsyncCompletion(long timeout)
Waits until all asynchronous tasks are finished, but waits no longer than the given number of milliseconds.
|
void addEventListener(EventListenerDescriptor listener)
The event listener is described by a EventListenerDescriptor
that may specify a priority. Both types of
listeners (immediate and post-commit) are registered.
listener
- the listener to addvoid removeEventListener(EventListenerDescriptor listener)
listener
- the listener to removevoid fireEvent(String name, EventContext context)
name
- the event namecontext
- the event contextvoid fireEvent(Event event)
If a transaction was started, the event is registered if needed to be sent after the transaction commit.
fireEvent
in interface EventProducer
event
- the event to firevoid fireEventBundle(EventBundle event)
The events are fired to PostCommitEventListener
listeners. Events are fired in the form of an event
bundle.
fireEventBundle
in interface EventProducer
event
- the event bundlevoid fireEventBundleSync(EventBundle event)
This means that asynchronous listeners will be run synchronously.
List<EventListener> getEventListeners()
Modification on this list will not modify the internal lists in this EventService
.
List<PostCommitEventListener> getPostCommitEventListeners()
Modification on this list will not modify the internal lists in this EventService
.
EventListenerDescriptor getEventListener(String name)
name
- the event listener namenull
if not foundvoid waitForAsyncCompletion()
void waitForAsyncCompletion(long timeout)
timeout
- the maximum time to wait for, in millisecondsCopyright © 2018 Nuxeo. All rights reserved.