server/filter/PluginFilter.java

/* 
 * i-scream central monitoring system
 * Copyright (C) 2000-2002 i-scream
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

//---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: tdb $
 * @version $Id: PluginFilter.java,v 1.6 2001/05/29 17:02:35 tdb 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.7
Committed:	Sat May 18 18:16:02 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.6:	+21 -2 lines
Log Message:	i-scream is now licensed under the GPL. I've added the GPL headers to every source file, and put a full copy of the license in the appropriate places. I think I've covered everything. This is going to be a mad commit ;)
#	User	Rev	Content
1	tdb	1.7	/*
2			* i-scream central monitoring system
3			* Copyright (C) 2000-2002 i-scream
4			*
5			* This program is free software; you can redistribute it and/or
6			* modify it under the terms of the GNU General Public License
7			* as published by the Free Software Foundation; either version 2
8			* of the License, or (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			*
15			* You should have received a copy of the GNU General Public License
16			* along with this program; if not, write to the Free Software
17			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18			*/
19
20	ajm	1.2	//---PACKAGE DECLARATION---
21	tdb	1.6	package uk.org.iscream.cms.server.filter;
22	ajm	1.2
23			//---IMPORTS---
24	tdb	1.6	import uk.org.iscream.cms.server.util.XMLPacket;
25	ajm	1.2
26			/**
27	tdb	1.4	* An interface to which a Plugin for a Filter must adhere.
28	ajm	1.2	*
29	tdb	1.7	* @author $Author: tdb $
30			* @version $Id: PluginFilter.java,v 1.6 2001/05/29 17:02:35 tdb Exp $
31	ajm	1.2	*/
32			public interface PluginFilter {
33	tdb	1.4
34	ajm	1.2	//---STATIC METHODS---
35
36			//---CONSTRUCTORS---
37
38			//---PUBLIC METHODS---
39
40			/**
41			* Return true if the filter wishes to allow the XMLPacket to pass
42			* to the next stage of the plugin filter pipeline. return false
43			* otherwise.
44			*
45			* @param packet the packet to filter on
46	tdb	1.3	* @return whether the packet is allow to continue on
47	ajm	1.2	*/
48			public boolean runFilter(XMLPacket packet);
49
50
51			/**
52			* Return a String representation of what the plugin filter
53	tdb	1.4	* does (e.g. "Rejects packets if x, y, and z")
54	ajm	1.2	*
55			* @return the description
56			*/
57			public String getDescription();
58
59			//---PRIVATE METHODS---
60
61			//---ACCESSOR/MUTATOR METHODS---
62
63			}