001/* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2012 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 */ 020package org.sonar.api.notifications; 021 022import org.sonar.api.BatchComponent; 023import org.sonar.api.ServerComponent; 024 025/** 026 * <p> 027 * The notification manager receives notifications and is in charge of storing them so that they are processed by the notification service. 028 * </p> 029 * <p> 030 * Pico provides an instance of this class, and plugins just need to create notifications and pass them to this manager with 031 * the {@link NotificationManager#scheduleForSending(Notification)} method. 032 * </p> 033 * 034 * @since 2.10 035 */ 036public interface NotificationManager extends ServerComponent, BatchComponent { 037 038 /** 039 * Receives a notification and stores it so that it is processed by the notification service. 040 * 041 * @param notification the notification. 042 */ 043 void scheduleForSending(Notification notification); 044 045}