| 1 |
ajm |
1.2 |
//---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 |
tdb |
1.3 |
* @author $Author: ajm4 $ |
| 11 |
|
|
* @version $Id: PluginFilter.java,v 1.2 2000/12/13 13:36:46 ajm4 Exp $ |
| 12 |
ajm |
1.2 |
*/ |
| 13 |
|
|
public interface PluginFilter { |
| 14 |
|
|
|
| 15 |
|
|
//---STATIC METHODS--- |
| 16 |
|
|
|
| 17 |
|
|
//---CONSTRUCTORS--- |
| 18 |
|
|
|
| 19 |
|
|
//---PUBLIC METHODS--- |
| 20 |
|
|
|
| 21 |
|
|
/** |
| 22 |
|
|
* Return true if the filter wishes to allow the XMLPacket to pass |
| 23 |
|
|
* to the next stage of the plugin filter pipeline. return false |
| 24 |
|
|
* otherwise. |
| 25 |
|
|
* |
| 26 |
|
|
* @param packet the packet to filter on |
| 27 |
tdb |
1.3 |
* @return whether the packet is allow to continue on |
| 28 |
ajm |
1.2 |
*/ |
| 29 |
|
|
public boolean runFilter(XMLPacket packet); |
| 30 |
|
|
|
| 31 |
|
|
|
| 32 |
|
|
/** |
| 33 |
|
|
* Return a String representation of what the plugin filter |
| 34 |
|
|
* does (e.g. "Rejects packets if x y and z") |
| 35 |
|
|
* |
| 36 |
|
|
* @return the description |
| 37 |
|
|
*/ |
| 38 |
|
|
public String getDescription(); |
| 39 |
|
|
|
| 40 |
|
|
//---PRIVATE METHODS--- |
| 41 |
|
|
|
| 42 |
|
|
//---ACCESSOR/MUTATOR METHODS--- |
| 43 |
|
|
|
| 44 |
|
|
} |
