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$
 * @version $Id$
 */
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.
    public boolean runFilter(XMLPacket packet);
    
    
    // return a String representation of what the plugin filter
    // does (e.g. "Rejects packets if x y and z")
    public String getDescription();

//---PRIVATE METHODS---

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

}
Revision:	1.1
Committed:	Wed Dec 6 22:58:30 2000 UTC (23 years, 5 months ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PACKAGEBUILD
Log Message:	Initial checkin of the PluginFilterManager, and the interface (java) for the actual Plugins.
#	User	Rev	Content
1	tdb	1.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			}