001/* 002 * SonarQube 003 * Copyright (C) 2009-2017 SonarSource SA 004 * mailto:info AT sonarsource DOT com 005 * 006 * This program 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 * This program 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 */ 020package org.sonar.api.notifications; 021 022import org.sonar.api.ExtensionPoint; 023import org.sonar.api.ce.ComputeEngineSide; 024import org.sonar.api.server.ServerSide; 025 026/** 027 * <p> 028 * Plugins should extend this class to provide implementation on a specific way to deliver notifications. 029 * 030 * For example: 031 * <ul> 032 * <li>email - sends email as soon as possible</li> 033 * <li>email (digest) - collects notifications and sends them together once a day</li> 034 * <li>gtalk - sends a chat message as soon as possible</li> 035 * </ul> 036 * 037 * @since 2.10 038 */ 039@ServerSide 040@ComputeEngineSide 041@ExtensionPoint 042public abstract class NotificationChannel { 043 044 /** 045 * Returns the unique key of this channel. 046 * 047 * @return the key 048 */ 049 public String getKey() { 050 return getClass().getSimpleName(); 051 } 052 053 /** 054 * Implements the delivery of the given notification to the given user. 055 * 056 * @param notification the notification to deliver 057 * @param userlogin the login of the user who should receive the notification 058 */ 059 public abstract void deliver(Notification notification, String userlogin); 060 061 @Override 062 public String toString() { 063 return getKey(); 064 } 065 066}