| 1 |
tdb |
1.7 |
/* |
| 2 |
|
|
* i-scream central monitoring system |
| 3 |
tdb |
1.8 |
* http://www.i-scream.org.uk |
| 4 |
tdb |
1.7 |
* Copyright (C) 2000-2002 i-scream |
| 5 |
|
|
* |
| 6 |
|
|
* This program is free software; you can redistribute it and/or |
| 7 |
|
|
* modify it under the terms of the GNU General Public License |
| 8 |
|
|
* as published by the Free Software Foundation; either version 2 |
| 9 |
|
|
* of the License, or (at your option) any later version. |
| 10 |
|
|
* |
| 11 |
|
|
* This program 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 this program; if not, write to the Free Software |
| 18 |
|
|
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 19 |
|
|
*/ |
| 20 |
|
|
|
| 21 |
ajm |
1.2 |
//---PACKAGE DECLARATION--- |
| 22 |
tdb |
1.6 |
package uk.org.iscream.cms.server.filter; |
| 23 |
ajm |
1.2 |
|
| 24 |
|
|
//---IMPORTS--- |
| 25 |
tdb |
1.6 |
import uk.org.iscream.cms.server.util.XMLPacket; |
| 26 |
ajm |
1.2 |
|
| 27 |
|
|
/** |
| 28 |
tdb |
1.4 |
* An interface to which a Plugin for a Filter must adhere. |
| 29 |
ajm |
1.2 |
* |
| 30 |
tdb |
1.7 |
* @author $Author: tdb $ |
| 31 |
tdb |
1.8 |
* @version $Id: PluginFilter.java,v 1.7 2002/05/18 18:16:02 tdb Exp $ |
| 32 |
ajm |
1.2 |
*/ |
| 33 |
|
|
public interface PluginFilter { |
| 34 |
tdb |
1.4 |
|
| 35 |
ajm |
1.2 |
//---STATIC METHODS--- |
| 36 |
|
|
|
| 37 |
|
|
//---CONSTRUCTORS--- |
| 38 |
|
|
|
| 39 |
|
|
//---PUBLIC METHODS--- |
| 40 |
|
|
|
| 41 |
|
|
/** |
| 42 |
|
|
* Return true if the filter wishes to allow the XMLPacket to pass |
| 43 |
|
|
* to the next stage of the plugin filter pipeline. return false |
| 44 |
|
|
* otherwise. |
| 45 |
|
|
* |
| 46 |
|
|
* @param packet the packet to filter on |
| 47 |
tdb |
1.3 |
* @return whether the packet is allow to continue on |
| 48 |
ajm |
1.2 |
*/ |
| 49 |
|
|
public boolean runFilter(XMLPacket packet); |
| 50 |
|
|
|
| 51 |
|
|
|
| 52 |
|
|
/** |
| 53 |
|
|
* Return a String representation of what the plugin filter |
| 54 |
tdb |
1.4 |
* does (e.g. "Rejects packets if x, y, and z") |
| 55 |
ajm |
1.2 |
* |
| 56 |
|
|
* @return the description |
| 57 |
|
|
*/ |
| 58 |
|
|
public String getDescription(); |
| 59 |
|
|
|
| 60 |
|
|
//---PRIVATE METHODS--- |
| 61 |
|
|
|
| 62 |
|
|
//---ACCESSOR/MUTATOR METHODS--- |
| 63 |
|
|
|
| 64 |
|
|
} |
