001 /* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2014 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * SonarQube 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 * SonarQube 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 License 017 * along with this program; if not, write to the Free Software Foundation, 018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 019 */ 020 package org.sonar.api.notifications; 021 022 import org.sonar.api.ServerExtension; 023 024 /** 025 * <p> 026 * Plugins should extend this class to provide implementation on a specific way to deliver notifications. 027 * </p> 028 * For example: 029 * <ul> 030 * <li>email - sends email as soon as possible</li> 031 * <li>email (digest) - collects notifications and sends them together once a day</li> 032 * <li>gtalk - sends a chat message as soon as possible</li> 033 * </ul> 034 * 035 * @since 2.10 036 */ 037 public abstract class NotificationChannel implements ServerExtension { 038 039 /** 040 * Returns the unique key of this channel. 041 * 042 * @return the key 043 */ 044 public String getKey() { 045 return getClass().getSimpleName(); 046 } 047 048 /** 049 * Implements the delivery of the given notification to the given user. 050 * 051 * @param notification the notification to deliver 052 * @param userlogin the login of the user who should receive the notification 053 */ 054 public abstract void deliver(Notification notification, String userlogin); 055 056 @Override 057 public String toString() { 058 return getKey(); 059 } 060 061 }