filter/plugins/EnforceEssentialData__Plugin.java

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

//---IMPORTS---
import uk.ac.ukc.iscream.filter.PluginFilter;
import uk.ac.ukc.iscream.filter.*;
import uk.ac.ukc.iscream.core.*;
import uk.ac.ukc.iscream.util.*;
import uk.ac.ukc.iscream.componentmanager.*;

/**
 * A first plugin! ;-)
 * this one rejects packets that do not contain all of the 'essential' data.
 *
 * @author  $Author: tdb1 $
 * @version $Id: EnforceEssentialData__Plugin.java,v 1.5 2001/01/19 00:08:04 tdb1 Exp $
 */
public class EnforceEssentialData__Plugin implements PluginFilter {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.5 $";
    
    public final String DESC = "Rejects packets that do not have an ip, machine_name, seq_no, date and type specified as attributes of the root packet tag.";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---

    // apply the filter and return true if successful.
    public boolean runFilter(XMLPacket packet){
        
        // need a special case for heartbeats
        if (packet.getParam("packet.attributes.type") == "heartbeat"
                && packet.getParam("packet.attributes.date") != null
                && packet.getParam("packet.attributes.ip") != null
                && packet.getParam("packet.attributes.machine_name") != null){
            return true;
        }
        
        // return false if any of the essential data is not present.
        if (packet.getParam("packet.attributes.machine_name") == null
                || packet.getParam("packet.attributes.ip") == null
                || packet.getParam("packet.attributes.seq_no") == null
                || packet.getParam("packet.attributes.date") == null
                || packet.getParam("packet.attributes.type") == null){
            return false;
        }
        
        // otherwise return true!
        return true;
        
    }

    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * This uses the uk.ac.ukc.iscream.util.NameFormat class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return FormatName.getName(
            _name,
            getClass().getName(),
            REVISION);
    }

    /**
     * return the String representation of what the filter does
     */
    public String getDescription(){
        return DESC;
    }

//---PRIVATE METHODS---

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

//---ATTRIBUTES---

    /**
     * This is the friendly identifier of the
     * component this class is running in.
     * eg, a Filter may be called "filter1",
     * If this class does not have an owning
     * component,  a name from the configuration
     * can be placed here.  This name could also
     * be changed to null for utility classes.
     */
    private String _name = FilterMain.NAME;

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = ReferenceManager.getInstance().getLogger();

//---STATIC ATTRIBUTES---

}
Revision:	1.6
Committed:	Fri Jan 19 00:12:08 2001 UTC (23 years, 4 months ago) by tdb
Branch:	MAIN
Changes since 1.5:	+10 -2 lines
Log Message:	Heartbeat packets do not contain a sequence number, so we best check for them specifically.
#	User	Rev	Content
1	ajm	1.2	//---PACKAGE DECLARATION---
2			package uk.ac.ukc.iscream.filter.plugins;
3
4			//---IMPORTS---
5			import uk.ac.ukc.iscream.filter.PluginFilter;
6	ajm	1.3	import uk.ac.ukc.iscream.filter.*;
7			import uk.ac.ukc.iscream.core.*;
8			import uk.ac.ukc.iscream.util.*;
9	tdb	1.4	import uk.ac.ukc.iscream.componentmanager.*;
10	ajm	1.2
11			/**
12			* A first plugin! ;-)
13			* this one rejects packets that do not contain all of the 'essential' data.
14			*
15	tdb	1.5	* @author $Author: tdb1 $
16	tdb	1.6	* @version $Id: EnforceEssentialData__Plugin.java,v 1.5 2001/01/19 00:08:04 tdb1 Exp $
17	ajm	1.2	*/
18			public class EnforceEssentialData__Plugin implements PluginFilter {
19
20			//---FINAL ATTRIBUTES---
21
22			/**
23			* The current CVS revision of this class
24			*/
25	tdb	1.6	public final String REVISION = "$Revision: 1.5 $";
26	ajm	1.2
27	tdb	1.5	public final String DESC = "Rejects packets that do not have an ip, machine_name, seq_no, date and type specified as attributes of the root packet tag.";
28	ajm	1.2
29			//---STATIC METHODS---
30
31			//---CONSTRUCTORS---
32
33			//---PUBLIC METHODS---
34
35			// apply the filter and return true if successful.
36			public boolean runFilter(XMLPacket packet){
37	tdb	1.6
38			// need a special case for heartbeats
39			if (packet.getParam("packet.attributes.type") == "heartbeat"
40			&& packet.getParam("packet.attributes.date") != null
41			&& packet.getParam("packet.attributes.ip") != null
42			&& packet.getParam("packet.attributes.machine_name") != null){
43			return true;
44			}
45	ajm	1.2
46			// return false if any of the essential data is not present.
47			if (packet.getParam("packet.attributes.machine_name") == null
48			\|\| packet.getParam("packet.attributes.ip") == null
49			\|\| packet.getParam("packet.attributes.seq_no") == null
50	tdb	1.5	\|\| packet.getParam("packet.attributes.date") == null
51			\|\| packet.getParam("packet.attributes.type") == null){
52	ajm	1.2	return false;
53			}
54
55			// otherwise return true!
56			return true;
57
58			}
59
60			/**
61			* Overrides the {@link java.lang.Object#toString() Object.toString()}
62			* method to provide clean logging (every class should have this).
63			*
64			* This uses the uk.ac.ukc.iscream.util.NameFormat class
65			* to format the toString()
66			*
67			* @return the name of this class and its CVS revision
68			*/
69			public String toString() {
70			return FormatName.getName(
71			_name,
72			getClass().getName(),
73			REVISION);
74			}
75
76			/**
77			* return the String representation of what the filter does
78			*/
79			public String getDescription(){
80			return DESC;
81			}
82
83			//---PRIVATE METHODS---
84
85			//---ACCESSOR/MUTATOR METHODS---
86
87			//---ATTRIBUTES---
88
89			/**
90			* This is the friendly identifier of the
91			* component this class is running in.
92			* eg, a Filter may be called "filter1",
93			* If this class does not have an owning
94			* component, a name from the configuration
95			* can be placed here. This name could also
96			* be changed to null for utility classes.
97			*/
98			private String _name = FilterMain.NAME;
99
100			/**
101			* This holds a reference to the
102			* system logger that is being used.
103			*/
104			private Logger _logger = ReferenceManager.getInstance().getLogger();
105
106			//---STATIC ATTRIBUTES---
107
108			}