server/filter/PluginFilter.java

//---PACKAGE DECLARATION---
package uk.ac.ukc.iscream.filter;

//---IMPORTS---
import uk.ac.ukc.iscream.util.XMLPacket;

/**
 * An interface to which a Plugin for a Filter must adhere.
 *
 * @author  $Author: tdb1 $
 * @version $Id: PluginFilter.java,v 1.3 2001/01/28 05:26:25 tdb1 Exp $
 */
public interface PluginFilter {

//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---

    /**
     * Return true if the filter wishes to allow the XMLPacket to pass
     * to the next stage of the plugin filter pipeline.  return false
     * otherwise.
     *
     * @param packet the packet to filter on
     * @return whether the packet is allow to continue on
     */
    public boolean runFilter(XMLPacket packet);
    
    
    /**
     * Return a String representation of what the plugin filter
     * does (e.g. "Rejects packets if x, y, and z")
     *
     * @return the description
     */
    public String getDescription();

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

}
Revision:	1.4
Committed:	Thu Feb 1 00:18:42 2001 UTC (23 years, 4 months ago) by tdb
Branch:	MAIN
Changes since 1.3:	+5 -5 lines
Log Message:	General tidy up, specifically focussing on the verbosity of logging messages.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.ac.ukc.iscream.filter;
3
4	//---IMPORTS---
5	import uk.ac.ukc.iscream.util.XMLPacket;
6
7	/**
8	* An interface to which a Plugin for a Filter must adhere.
9	*
10	* @author $Author: tdb1 $
11	* @version $Id: PluginFilter.java,v 1.3 2001/01/28 05:26:25 tdb1 Exp $
12	*/
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	* @return whether the packet is allow to continue on
28	*/
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	}