server/filter/PluginFilter.java

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.server.filter;

//---IMPORTS---
import uk.org.iscream.cms.server.util.XMLPacket;

/**
 * An interface to which a Plugin for a Filter must adhere.
 *
 * @author  $Author: tdb1 $
 * @version $Id: PluginFilter.java,v 1.5 2001/03/14 23:25:29 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.6
Committed:	Tue May 29 17:02:35 2001 UTC (23 years ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PIRCBOT
Changes since 1.5:	+3 -3 lines
Log Message:	Major change in the java package naming. This has been held off for some time now, but it really needed doing. The future packaging of all i-scream products will be; uk.org.iscream.<product>.<subpart>.* In the case of the central monitoring system server this will be; uk.org.iscream.cms.server.* The whole server has been changed to follow this structure, and tested to a smallish extent. Further changes in other parts of the CMS will follow.
#	User	Rev	Content
1	ajm	1.2	//---PACKAGE DECLARATION---
2	tdb	1.6	package uk.org.iscream.cms.server.filter;
3	ajm	1.2
4			//---IMPORTS---
5	tdb	1.6	import uk.org.iscream.cms.server.util.XMLPacket;
6	ajm	1.2
7			/**
8	tdb	1.4	* An interface to which a Plugin for a Filter must adhere.
9	ajm	1.2	*
10	tdb	1.4	* @author $Author: tdb1 $
11	tdb	1.6	* @version $Id: PluginFilter.java,v 1.5 2001/03/14 23:25:29 tdb1 Exp $
12	ajm	1.2	*/
13			public interface PluginFilter {
14	tdb	1.4
15	ajm	1.2	//---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	tdb	1.4	* does (e.g. "Rejects packets if x, y, and z")
35	ajm	1.2	*
36			* @return the description
37			*/
38			public String getDescription();
39
40			//---PRIVATE METHODS---
41
42			//---ACCESSOR/MUTATOR METHODS---
43
44			}