View Javadoc

1   /*
2    * Copyright (c) 2002 Peter Antman, Teknik i Media  <peter.antman@tim.se>
3    *
4    * $Id: Sender.java,v 1.1.1.1 2004/05/19 12:33:40 pra Exp $
5    *
6    * This library is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public
8    * License as published by the Free Software Foundation; either
9    * version 2 of the License, or (at your option) any later version
10   * 
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Lesser General Public License for more details.
15   * 
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this library; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   */
20  package org.backsource.alert;
21  import java.util.List;
22  import java.util.Properties;
23  /***
24   * Interface of a sender.
25   *
26   * <p>A sender is a class that delivers the reported errors and warnings to
27   *  a destinations of some sort, such as Mail, SMS, Pager, Jabber, syslog,
28   *  instant news or JMS. The preexisting senders is found in {@link org.backsource.alert.sender}.</p>
29   * @author <a href="mailto:pra@tim.se">Peter Antman</a>
30   * @version $Revision: 1.1.1.1 $
31   */
32  
33  public interface  Sender {
34     /***
35      * Send the errors and warnings given.
36      */
37     public void sendErrors(List errors, List warnings);
38     /***
39      * Send the warnings given.
40      *
41      * <p>It is up to the sender to decide, based on configuration or statically
42      * if it should really send warnings.</p>
43      */
44     public void sendWarnings(List warnings);
45     /***
46      * Set the properties of the sender.
47      */
48     public void setProperties(Properties prop) throws Exception;
49  }// Sender