blob: fc2e5d179937b751ecc1af1eda9dd2432e2a8618 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
/*
* SonarQube
* Copyright (C) 2009-2018 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.notifications;
import org.sonar.api.ExtensionPoint;
import org.sonar.api.ce.ComputeEngineSide;
import org.sonar.api.server.ServerSide;
/**
* <p>
* Plugins should extend this class to provide implementation on a specific way to deliver notifications.
*
* For example:
* <ul>
* <li>email - sends email as soon as possible</li>
* <li>email (digest) - collects notifications and sends them together once a day</li>
* <li>gtalk - sends a chat message as soon as possible</li>
* </ul>
*
* @since 2.10
*/
@ServerSide
@ComputeEngineSide
@ExtensionPoint
public abstract class NotificationChannel {
/**
* Returns the unique key of this channel.
*
* @return the key
*/
public String getKey() {
return getClass().getSimpleName();
}
/**
* Implements the delivery of the given notification to the given user.
*
* @param notification the notification to deliver
* @param userlogin the login of the user who should receive the notification
* @return whether the notification was sent or not
*/
public abstract boolean deliver(Notification notification, String userlogin);
@Override
public String toString() {
return getKey();
}
}
|
