org.sonar.api.notifications

Class NotificationChannel

java.lang.Object

org.sonar.api.notifications.NotificationChannel

@ServerSide
 @ComputeEngineSide
 @ExtensionPoint
public abstract class NotificationChannel
extends java.lang.Object

Plugins should extend this class to provide implementation on a specific way to deliver notifications. For example:

• email - sends email as soon as possible
• email (digest) - collects notifications and sends them together once a day
• gtalk - sends a chat message as soon as possible

Since:

2.10

Constructor Summary

Constructors

Constructor and Description
NotificationChannel()

Method Summary

Modifier and Type	Method and Description
abstract boolean	deliver(Notification notification, java.lang.String userlogin) Implements the delivery of the given notification to the given user.
java.lang.String	getKey() Returns the unique key of this channel.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationChannel

public NotificationChannel()

Method Detail

getKey

public java.lang.String getKey()

Returns the unique key of this channel.

Returns:

the key

deliver

public abstract boolean deliver(Notification notification,
                                java.lang.String userlogin)

Implements the delivery of the given notification to the given user.

Parameters:

notification - the notification to deliver

userlogin - the login of the user who should receive the notification

Returns:

whether the notification was sent or not

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object