org.sonar.api.notifications.NotificationDispatcher Maven / Gradle / Ivy
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube 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.
*
* SonarQube 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.apache.commons.lang.StringUtils;
import org.sonar.api.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:
*
* - notify me by email when someone comments an issue reported by me
* - notify me by twitter when someone comments an issue assigned to me
* - notify me by Jabber when someone mentions me in an issue comment
* - send me by SMS when there are system notifications (like password reset, account creation, ...)
*
*
* @since 2.10
*/
public abstract class NotificationDispatcher implements ServerExtension {
private String notificationType;
/**
* Additional information related to the notification, which will be used
* to know who should receive the notification.
*/
public interface Context {
/**
* This method is not used any longer. Calling it will result in an {@link UnsupportedOperationException}.
*
* @deprecated Use {@link #addUser(String, NotificationChannel)} instead.
*/
@Deprecated
void addUser(String userLogin);
/**
* Adds a user that will be notified through the given notification channel.
*
* @param userLogin the user login
* @param notificationChannel the notification channel to use for this user
*/
void addUser(String userLogin, NotificationChannel notificationChannel);
}
/**
* Creates a new dispatcher for notifications of the given type.
*
* @param notificationType the type of notifications handled by this dispatcher
*/
public NotificationDispatcher(String notificationType) {
this.notificationType = notificationType;
}
/**
* Creates a new generic dispatcher, used for any kind of notification.
*
* Should be avoided and replaced by the other constructor - as it is easier to understand that a
* dispatcher listens for a specific type of notification.
*/
public NotificationDispatcher() {
this("");
}
/**
* The unique key of this dispatcher. By default it's the class name without the package prefix.
*
* The related label in l10n bundles is 'notification.dispatcher.', for example 'notification.dispatcher.NewFalsePositive'.
*/
public String getKey() {
return getClass().getSimpleName();
}
/**
*
* Performs the dispatch.
*
*/
public final void performDispatch(Notification notification, Context context) {
if (StringUtils.equals(notification.getType(), notificationType) || StringUtils.equals("", notificationType)) {
dispatch(notification, 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 abstract void dispatch(Notification notification, Context context);
@Override
public String toString() {
return getKey();
}
}