public abstract class NotificationDispatcher extends Object implements ServerExtension
Plugins should extend this class to provide logic to determine which users are interested in receiving notifications, along with which delivery channels they selected.
For example:Modifier and Type | Class and Description |
---|---|
static interface |
NotificationDispatcher.Context
Additional information related to the notification, which will be used
to know who should receive the notification.
|
Constructor and Description |
---|
NotificationDispatcher()
Creates a new generic dispatcher, used for any kind of notification.
|
NotificationDispatcher(String notificationType)
Creates a new dispatcher for notifications of the given type.
|
Modifier and Type | Method and Description |
---|---|
abstract void |
dispatch(Notification notification,
NotificationDispatcher.Context context)
Implements the logic that defines which users will receive the notification.
|
String |
getKey()
Returns the unique key of this dispatcher.
|
void |
performDispatch(Notification notification,
NotificationDispatcher.Context context)
Performs the dispatch.
|
String |
toString() |
public NotificationDispatcher(String notificationType)
notificationType
- the type of notifications handled by this dispatcherpublic NotificationDispatcher()
public final void performDispatch(Notification notification, NotificationDispatcher.Context context)
Performs the dispatch.
notification
- the notification that will be sentthe
- context linked to this notificationpublic abstract void dispatch(Notification notification, NotificationDispatcher.Context context)
Implements the logic that defines which users will receive the notification.
The purpose of this method is to populate the context object with users, based on the type of notification and the content of the notification.notification
- the notification that will be sentthe
- context linked to this notificationCopyright © 2009-2013 SonarSource. All Rights Reserved.