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