source/mircoders/localizer/MirAntiAbuseFilterType.java

   1 /*\r
   2  * Copyright (C) 2001, 2002 The Mir-coders group\r
   3  *\r
   4  * This file is part of Mir.\r
   5  *\r
   6  * Mir is free software; you can redistribute it and/or modify\r
   7  * it under the terms of the GNU General Public License as published by\r
   8  * the Free Software Foundation; either version 2 of the License, or\r
   9  * (at your option) any later version.\r
  10  *\r
  11  * Mir is distributed in the hope that it will be useful,\r
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14  * GNU General Public License for more details.\r
  15  *\r
  16  * You should have received a copy of the GNU General Public License\r
  17  * along with Mir; if not, write to the Free Software\r
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19  *\r
  20  * In addition, as a special exception, The Mir-coders gives permission to link\r
  21  * the code of this program with  any library licensed under the Apache Software License,\r
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library\r
  23  * (or with modified versions of the above that use the same license as the above),\r
  24  * and distribute linked combinations including the two.  You must obey the\r
  25  * GNU General Public License in all respects for all of the code used other than\r
  26  * the above mentioned libraries.  If you modify this file, you may extend this\r
  27  * exception to your version of the file, but you are not obligated to do so.\r
  28  * If you do not wish to do so, delete this exception statement from your version.\r
  29  */\r
  30 package mircoders.localizer;\r
  31 \r
  32 import mir.entity.Entity;\r
  33 import mir.session.Request;\r
  34 \r
  35 /**\r
  36  *\r
  37  *\r
  38  * <p>Title: Anti-abuse filter type</p>\r
  39  * <p>Description: Interface to define filter types for the anti-abuse system\r
  40  *  </p>\r
  41  * <p>Copyright: Copyright (c) 2003</p>\r
  42  * <p>Company: Mir coders</p>\r
  43  * @author Zapata\r
  44  * @version 1.0\r
  45  */\r
  46 \r
  47 public interface MirAntiAbuseFilterType {\r
  48   /**\r
  49    * The identifying name of the filter type. Must be unique.\r
  50    *\r
  51    * @return\r
  52    */\r
  53   public String getName();\r
  54 \r
  55   /**\r
  56    * Must return <code>true</code> if the expression is valid for this filter. <code>false</code> if not.\r
  57    * @param anExpression\r
  58    * @return\r
  59    */\r
  60   public boolean validate(String anExpression);\r
  61 \r
  62   /**\r
  63    * Must return <code>true</code> if the posting matches the filter.\r
  64    * @param anExpression\r
  65    * @return\r
  66    */\r
  67   public boolean test(String anExpression, Entity anEntity, Request aRequest);\r
  68 }