source/mircoders/localizer/MirAntiAbuseFilterType.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 mircoders.localizer;
  31
  32 import mir.entity.Entity;
  33 import mir.session.Request;
  34
  35 /**
  36  *
  37  *
  38  * <p>Title: Anti-abuse filter type</p>
  39  * <p>Description: Interface to define filter types for the anti-abuse system
  40  *  </p>
  41  * <p>Copyright: Copyright (c) 2003</p>
  42  * <p>Company: Mir coders</p>
  43  * @author Zapata
  44  * @version 1.0
  45  */
  46
  47 public interface MirAntiAbuseFilterType {
  48   /**
  49    * The identifying name of the filter type. Must be unique.
  50    *
  51    * @return
  52    */
  53   public String getName();
  54
  55   /**
  56    * Must return <code>true</code> if the expression is valid for this filter. <code>false</code> if not.
  57    * @param anExpression
  58    * @return
  59    */
  60   public boolean validate(String anExpression);
  61
  62   /**
  63    * Must return <code>true</code> if the posting matches the filter.
  64    * @param anExpression
  65    * @return
  66    */
  67   public boolean test(String anExpression, Entity anEntity, Request aRequest);
  68 }