server/filter/PluginFilter.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org
 * 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.util.XMLPacket;

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