1 |
//---PACKAGE DECLARATION--- |
2 |
package uk.ac.ukc.iscream.filter.plugins; |
3 |
|
4 |
//---IMPORTS--- |
5 |
import uk.ac.ukc.iscream.filter.PluginFilter; |
6 |
import uk.ac.ukc.iscream.filter.*; |
7 |
import uk.ac.ukc.iscream.core.*; |
8 |
import uk.ac.ukc.iscream.util.*; |
9 |
import uk.ac.ukc.iscream.componentmanager.*; |
10 |
|
11 |
/** |
12 |
* A first plugin! ;-) |
13 |
* this one rejects packets that do not contain all of the 'essential' data. |
14 |
* |
15 |
* @author $Author: tdb1 $ |
16 |
* @version $Id: EnforceEssentialData__Plugin.java,v 1.5 2001/01/19 00:08:04 tdb1 Exp $ |
17 |
*/ |
18 |
public class EnforceEssentialData__Plugin implements PluginFilter { |
19 |
|
20 |
//---FINAL ATTRIBUTES--- |
21 |
|
22 |
/** |
23 |
* The current CVS revision of this class |
24 |
*/ |
25 |
public final String REVISION = "$Revision: 1.5 $"; |
26 |
|
27 |
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 |
|
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 |
|
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 |
|
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 |
|| packet.getParam("packet.attributes.date") == null |
51 |
|| packet.getParam("packet.attributes.type") == null){ |
52 |
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 |
} |