source/mir/producer/Producer.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir 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
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package mir.producer;
  31
  32 import mir.log.LoggerWrapper;
  33
  34 /**
  35  * <p>A Producer is  a set of tasks, scripted  in xml. Producers allow
  36  * mir installations to have their  own actions that can be called for
  37  * instance when  a new article is posted.   Originally producers were
  38  * mostly used  to generate  pages, but  they are used  for a  lot of
  39  * other  tasks such  as  pulling rss  feeds  for the  global wire  on
  40  * indymedia.org. </p>
  41  *
  42  * <p>Producers  can  be  easily  added  and  configured  through  the
  43  * producers.xml file.</p>
  44  *
  45  * <p>In the  admin web interface,  producers appear, for  example, on
  46  * the admin->"Generate manually"->"advanced page": (as Tasks)</p>
  47  *
  48  * <p>Architecture: a "poducer" tag  in the producers.xml file defines
  49  * a small  program. This program  (or script) may  contain constructs
  50  * such as  if, loop,  and variables... The  program is parsed  into a
  51  * tree  of ProducerNodes.   The root  of this  tree is  defined  in a
  52  * NodedProducer (which  is the  only class that  currently implements
  53  * the  Producer  interface).   When  the Producer  is  executed,  the
  54  * "produce" methods of each  node are recursively called, effectively
  55  * executing the program as it was scripted</p>
  56  *
  57  *
  58  */
  59 public interface Producer {
  60   /**
  61    *
  62    *
  63    * @param aLogger
  64    * @return <code>false</code> if aborted,<code>true</code> if not
  65    * @throws ProducerFailure
  66    * @throws ProducerExc
  67    */
  68   public boolean produce( LoggerWrapper aLogger ) throws ProducerFailure, ProducerExc;
  69   public void abort();
  70 }