| 1 |
< |
//---PACKAGE DECLARATION--- |
| 2 |
< |
package uk.ac.ukc.iscream.filter; |
| 3 |
< |
|
| 4 |
< |
//---IMPORTS--- |
| 5 |
< |
import uk.ac.ukc.iscream.util.XMLPacket; |
| 6 |
< |
|
| 7 |
< |
/** |
| 8 |
< |
* the plugin filter interface |
| 9 |
< |
* |
| 10 |
< |
* @author $Author$ |
| 11 |
< |
* @version $Id$ |
| 12 |
< |
*/ |
| 13 |
< |
public interface PluginFilter { |
| 14 |
< |
|
| 15 |
< |
//---STATIC METHODS--- |
| 16 |
< |
|
| 17 |
< |
//---CONSTRUCTORS--- |
| 18 |
< |
|
| 19 |
< |
//---PUBLIC METHODS--- |
| 20 |
< |
|
| 21 |
< |
// return true if the filter wishes to allow the XMLPacket to pass |
| 22 |
< |
// to the next stage of the plugin filter pipeline. return false |
| 23 |
< |
// otherwise. |
| 24 |
< |
public boolean runFilter(XMLPacket packet); |
| 25 |
< |
|
| 26 |
< |
|
| 27 |
< |
// return a String representation of what the plugin filter |
| 28 |
< |
// does (e.g. "Rejects packets if x y and z") |
| 29 |
< |
public String getDescription(); |
| 30 |
< |
|
| 31 |
< |
//---PRIVATE METHODS--- |
| 32 |
< |
|
| 33 |
< |
//---ACCESSOR/MUTATOR METHODS--- |
| 34 |
< |
|
| 35 |
< |
} |
| 1 |
> |
/* |
| 2 |
> |
* i-scream central monitoring system |
| 3 |
> |
* Copyright (C) 2000-2002 i-scream |
| 4 |
> |
* |
| 5 |
> |
* This program is free software; you can redistribute it and/or |
| 6 |
> |
* modify it under the terms of the GNU General Public License |
| 7 |
> |
* as published by the Free Software Foundation; either version 2 |
| 8 |
> |
* of the License, or (at your option) any later version. |
| 9 |
> |
* |
| 10 |
> |
* This program is distributed in the hope that it will be useful, |
| 11 |
> |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 |
> |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 |
> |
* GNU General Public License for more details. |
| 14 |
> |
* |
| 15 |
> |
* You should have received a copy of the GNU General Public License |
| 16 |
> |
* along with this program; if not, write to the Free Software |
| 17 |
> |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 18 |
> |
*/ |
| 19 |
> |
|
| 20 |
> |
//---PACKAGE DECLARATION--- |
| 21 |
> |
package uk.org.iscream.cms.server.filter; |
| 22 |
> |
|
| 23 |
> |
//---IMPORTS--- |
| 24 |
> |
import uk.org.iscream.cms.server.util.XMLPacket; |
| 25 |
> |
|
| 26 |
> |
/** |
| 27 |
> |
* An interface to which a Plugin for a Filter must adhere. |
| 28 |
> |
* |
| 29 |
> |
* @author $Author$ |
| 30 |
> |
* @version $Id$ |
| 31 |
> |
*/ |
| 32 |
> |
public interface PluginFilter { |
| 33 |
> |
|
| 34 |
> |
//---STATIC METHODS--- |
| 35 |
> |
|
| 36 |
> |
//---CONSTRUCTORS--- |
| 37 |
> |
|
| 38 |
> |
//---PUBLIC METHODS--- |
| 39 |
> |
|
| 40 |
> |
/** |
| 41 |
> |
* Return true if the filter wishes to allow the XMLPacket to pass |
| 42 |
> |
* to the next stage of the plugin filter pipeline. return false |
| 43 |
> |
* otherwise. |
| 44 |
> |
* |
| 45 |
> |
* @param packet the packet to filter on |
| 46 |
> |
* @return whether the packet is allow to continue on |
| 47 |
> |
*/ |
| 48 |
> |
public boolean runFilter(XMLPacket packet); |
| 49 |
> |
|
| 50 |
> |
|
| 51 |
> |
/** |
| 52 |
> |
* Return a String representation of what the plugin filter |
| 53 |
> |
* does (e.g. "Rejects packets if x, y, and z") |
| 54 |
> |
* |
| 55 |
> |
* @return the description |
| 56 |
> |
*/ |
| 57 |
> |
public String getDescription(); |
| 58 |
> |
|
| 59 |
> |
//---PRIVATE METHODS--- |
| 60 |
> |
|
| 61 |
> |
//---ACCESSOR/MUTATOR METHODS--- |
| 62 |
> |
|
| 63 |
> |
} |
