Package org.jivesoftware.openfire.event
Class UserEventDispatcher
java.lang.Object
org.jivesoftware.openfire.event.UserEventDispatcher
Dispatches user events. Each event has a
type
and optional parameters, as follows:
Event Type | Extra Params | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
user_created | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_deleting | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_modified |
|
- Author:
- Matt Tucker
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Represents valid event types. -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addListener
(UserEventListener listener) Registers a listener to receive events.static void
dispatchEvent
(User user, UserEventDispatcher.EventType eventType, Map<String, Object> params) Dispatches an event to all listeners.static void
removeListener
(UserEventListener listener) Unregisters a listener to receive events.
-
Method Details
-
addListener
Registers a listener to receive events.- Parameters:
listener
- the listener.
-
removeListener
Unregisters a listener to receive events.- Parameters:
listener
- the listener.
-
dispatchEvent
public static void dispatchEvent(User user, UserEventDispatcher.EventType eventType, Map<String, Object> params) Dispatches an event to all listeners.- Parameters:
user
- the user.eventType
- the event type.params
- event parameters.
-