|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.sonar.api.notifications.NotificationDispatcher
public abstract class NotificationDispatcher
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:
Nested Class Summary | |
---|---|
static interface |
NotificationDispatcher.Context
Additional information related to the notification, which will be used to know who should receive the notification. |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
abstract void |
dispatch(Notification notification,
NotificationDispatcher.Context context)
Implements the logic that defines which users will receive the notification. |
String |
getKey()
The unique key of this dispatcher. |
void |
performDispatch(Notification notification,
NotificationDispatcher.Context context)
Performs the dispatch. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public NotificationDispatcher(String notificationType)
notificationType
- the type of notifications handled by this dispatcherpublic NotificationDispatcher()
Method Detail |
---|
public String getKey()
public final void performDispatch(Notification notification, NotificationDispatcher.Context context)
Performs the dispatch.
public 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.
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |