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.util.XMLPacket; |
7 |
|
8 |
/** |
9 |
* A first plugin! ;-) |
10 |
* this one rejects packets that do not contain all of the 'essential' data. |
11 |
* |
12 |
* @author $Author$ |
13 |
* @version $Id$ |
14 |
*/ |
15 |
public class EnforceEssentialData__Plugin implements PluginFilter { |
16 |
|
17 |
//---FINAL ATTRIBUTES--- |
18 |
|
19 |
/** |
20 |
* The current CVS revision of this class |
21 |
*/ |
22 |
public final String REVISION = "$Revision: 1.1 $"; |
23 |
|
24 |
public final String DESC = "Rejects packets that do not have an ip, machine_name, seq_no and date specified as attributes of the root packet tag."; |
25 |
|
26 |
//---STATIC METHODS--- |
27 |
|
28 |
//---CONSTRUCTORS--- |
29 |
|
30 |
//---PUBLIC METHODS--- |
31 |
|
32 |
// apply the filter and return true if successful. |
33 |
public boolean runFilter(XMLPacket packet){ |
34 |
|
35 |
// return false if any of the essential data is not present. |
36 |
if (packet.getParam("packet.attributes.machine_name") == null |
37 |
|| packet.getParam("packet.attributes.ip") == null |
38 |
|| packet.getParam("packet.attributes.seq_no") == null |
39 |
|| packet.getParam("packet.attributes.date") == null){ |
40 |
return false; |
41 |
} |
42 |
|
43 |
// otherwise return true! |
44 |
return true; |
45 |
|
46 |
} |
47 |
|
48 |
/** |
49 |
* Overrides the {@link java.lang.Object#toString() Object.toString()} |
50 |
* method to provide clean logging (every class should have this). |
51 |
* |
52 |
* @return the name of this class and its CVS revision |
53 |
*/ |
54 |
public String toString() { |
55 |
return this.getClass().getName() + "(" + REVISION.substring(11, REVISION.length() - 2) + ")"; |
56 |
} |
57 |
|
58 |
// return the String representation of what the filter does |
59 |
public String getDescription(){ |
60 |
return DESC; |
61 |
} |
62 |
|
63 |
//---PRIVATE METHODS--- |
64 |
|
65 |
//---ACCESSOR/MUTATOR METHODS--- |
66 |
|
67 |
//---ATTRIBUTES--- |
68 |
|
69 |
//---STATIC ATTRIBUTES--- |
70 |
|
71 |
} |