source/mir/producer/Producer.java

   1 /*
   2  * Copyright (C) 2001-2006 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  * and distribute linked combinations including the two.  You must obey the
  23  * GNU General Public License in all respects for all of the code used other than
  24  * the above mentioned libraries.  If you modify this file, you may extend this
  25  * exception to your version of the file, but you are not obligated to do so.
  26  * If you do not wish to do so, delete this exception statement from your version.
  27  */
  28 package mir.producer;
  29
  30 /**
  31  * <p>A Producer is  a set of tasks, scripted  in xml. Producers allow
  32  * mir installations to have their  own actions that can be called for
  33  * instance when  a new article is posted.   Originally producers were
  34  * mostly used  to generate  pages, but  they are used  for a  lot of
  35  * other  tasks such  as  pulling rss  feeds  for the  global wire  on
  36  * indymedia.org. </p>
  37  *
  38  * <p>Producers  can  be  easily  added  and  configured  through  the
  39  * producers.xml file.</p>
  40  *
  41  * <p>In the  admin web interface,  producers appear, for  example, on
  42  * the admin->"Generate manually"->"advanced page": (as Tasks)</p>
  43  *
  44  * <p>Architecture: a "poducer" tag  in the producers.xml file defines
  45  * a small  program. This program  (or script) may  contain constructs
  46  * such as  if, loop,  and variables... The  program is parsed  into a
  47  * tree  of ProducerNodes.   The root  of this  tree is  defined  in a
  48  * NodedProducer (which  is the  only class that  currently implements
  49  * the  Producer  interface).   When  the Producer  is  executed,  the
  50  * "produce" methods of each  node are recursively called, effectively
  51  * executing the program as it was scripted</p>
  52  */
  53 public interface Producer {
  54   /**
  55    * Execute the producer
  56    */
  57   public boolean execute(ProductionContext aContext) throws ProducerFailure, ProducerExc;
  58
  59   /**
  60    * Abort the execution of the producer. Will be called from a different
  61    * thread and implementations should take this into account.
  62    */
  63   public void abort(ProductionContext aContext);
  64 }