001 /* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2011 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * Sonar is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * Sonar is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public 017 * License along with Sonar; if not, write to the Free Software 018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 019 */ 020 package org.sonar.api.notifications; 021 022 import org.sonar.api.ServerExtension; 023 024 /** 025 * Provides logic to determine which users are interested in receiving notification. 026 * Has no knowledge about the way of delivery. 027 * For example: 028 * <ul> 029 * <li>notify me when someone comments on review created by me</li> 030 * <li>notify me when someone comments on review assigned to me</li> 031 * <li>notify me when someone mentions me in comment for review</li> 032 * <li>send me system notifications (like password reset, account creation, ...)</li> 033 * </ul> 034 * 035 * @since 2.10 036 */ 037 public abstract class NotificationDispatcher implements ServerExtension { 038 039 public interface Context { 040 void addUser(String username); 041 } 042 043 /** 044 * @return unique key of this dispatcher 045 */ 046 public String getKey() { 047 return getClass().getSimpleName(); 048 } 049 050 /** 051 * @return recipients 052 */ 053 public abstract void dispatch(Notification notification, Context context); 054 055 @Override 056 public String toString() { 057 return getKey(); 058 } 059 060 }