org.sonar.api.notifications
Class NotificationDispatcher

java.lang.Object
  org.sonar.api.notifications.NotificationDispatcher

All Implemented Interfaces:

Extension, ServerComponent, ServerExtension

Direct Known Subclasses:

ChangesInReviewAssignedToMeOrCreatedByMe, NewViolationsOnMyFavouriteProject

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. It has no knowledge about the way of delivery.

For example:

• notify me when someone comments on review created by me
• notify me when someone comments on review assigned to me
• notify me when someone mentions me in comment for review
• send me system notifications (like password reset, account creation, ...)

Since:

2.10

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()

Method Summary

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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NotificationDispatcher

public NotificationDispatcher()

Method Detail

getKey

public String getKey()

Returns the unique key of this dispatcher.

Returns:

the key

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.

Parameters:

notification - the notification that will be sent

the - context linked to this notification

toString

public String toString()

Overrides:

toString in class Object