server/filter/PluginFilter.java

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

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

/**
 * the plugin filter interface
 *
 * @author  $Author: tdb1 $
 * @version $Id: PluginFilter.java,v 1.1 2000/12/06 22:58:30 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
     */
    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.2
Committed:	Wed Dec 13 13:36:46 2000 UTC (23 years, 5 months ago) by ajm
Branch:	MAIN
Changes since 1.1:	+43 -35 lines
Log Message:	componenterized the filter and tidied all child classes, no all conform to toString standard
#	User	Rev	Content
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			* @author $Author: tdb1 $
11			* @version $Id: PluginFilter.java,v 1.1 2000/12/06 22:58:30 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			*/
28			public boolean runFilter(XMLPacket packet);
29
30
31			/**
32			* Return a String representation of what the plugin filter
33			* does (e.g. "Rejects packets if x y and z")
34			*
35			* @return the description
36			*/
37			public String getDescription();
38
39			//---PRIVATE METHODS---
40
41			//---ACCESSOR/MUTATOR METHODS---
42
43			}