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 deliver notification.
026     * For example:
027     * <ul>
028     * <li>email - sends email as soon as possible</li>
029     * <li>email (digest) - collects notifications and sends them together once a day</li>
030     * <li>gtalk - sends a chat message as soon as possible</li>
031     * </ul>
032     * 
033     * @since 2.10
034     */
035    public abstract class NotificationChannel implements ServerExtension {
036    
037      /**
038       * @return unique key of this channel
039       */
040      public String getKey() {
041        return getClass().getSimpleName();
042      }
043    
044      public abstract void deliver(Notification notification, String username);
045    
046      @Override
047      public String toString() {
048        return getKey();
049      }
050    
051    }