1 |
tdb |
1.12 |
/* |
2 |
|
|
* i-scream central monitoring system |
3 |
tdb |
1.16 |
* http://www.i-scream.org |
4 |
tdb |
1.12 |
* 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 |
ajm |
1.2 |
//---PACKAGE DECLARATION--- |
22 |
tdb |
1.10 |
package uk.org.iscream.cms.server.filter.plugins; |
23 |
ajm |
1.2 |
|
24 |
|
|
//---IMPORTS--- |
25 |
tdb |
1.10 |
import uk.org.iscream.cms.server.filter.PluginFilter; |
26 |
|
|
import uk.org.iscream.cms.server.filter.*; |
27 |
|
|
import uk.org.iscream.cms.server.core.*; |
28 |
tdb |
1.14 |
import uk.org.iscream.cms.util.*; |
29 |
tdb |
1.10 |
import uk.org.iscream.cms.server.componentmanager.*; |
30 |
ajm |
1.2 |
|
31 |
|
|
/** |
32 |
tdb |
1.11 |
* This plugin rejects packets that do not |
33 |
|
|
* contain all of the 'essential' data. |
34 |
ajm |
1.2 |
* |
35 |
tdb |
1.12 |
* @author $Author: tdb $ |
36 |
tdb |
1.16 |
* @version $Id: EnforceEssentialData__Plugin.java,v 1.15 2003/02/24 20:18:49 tdb Exp $ |
37 |
ajm |
1.2 |
*/ |
38 |
|
|
public class EnforceEssentialData__Plugin implements PluginFilter { |
39 |
|
|
|
40 |
|
|
//---FINAL ATTRIBUTES--- |
41 |
|
|
|
42 |
|
|
/** |
43 |
|
|
* The current CVS revision of this class |
44 |
|
|
*/ |
45 |
tdb |
1.16 |
public final String REVISION = "$Revision: 1.15 $"; |
46 |
ajm |
1.2 |
|
47 |
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."; |
48 |
ajm |
1.2 |
|
49 |
|
|
//---STATIC METHODS--- |
50 |
|
|
|
51 |
|
|
//---CONSTRUCTORS--- |
52 |
|
|
|
53 |
|
|
//---PUBLIC METHODS--- |
54 |
|
|
|
55 |
|
|
// apply the filter and return true if successful. |
56 |
|
|
public boolean runFilter(XMLPacket packet){ |
57 |
|
|
|
58 |
tdb |
1.8 |
// return true if a queueStat packet seems ok |
59 |
|
|
if (packet.getParam("packet.attributes.type").equals("queueStat") |
60 |
|
|
&& packet.getParam("packet.attributes.date") != null |
61 |
|
|
&& packet.getParam("packet.attributes.name") != null){ |
62 |
|
|
return true; |
63 |
|
|
} |
64 |
|
|
|
65 |
|
|
// return false if any of the essential data is not present |
66 |
|
|
// in a "data" packet |
67 |
ajm |
1.2 |
if (packet.getParam("packet.attributes.machine_name") == null |
68 |
|
|
|| packet.getParam("packet.attributes.ip") == null |
69 |
|
|
|| packet.getParam("packet.attributes.seq_no") == null |
70 |
tdb |
1.5 |
|| packet.getParam("packet.attributes.date") == null |
71 |
|
|
|| packet.getParam("packet.attributes.type") == null){ |
72 |
ajm |
1.2 |
return false; |
73 |
|
|
} |
74 |
|
|
|
75 |
|
|
// otherwise return true! |
76 |
|
|
return true; |
77 |
|
|
|
78 |
|
|
} |
79 |
|
|
|
80 |
|
|
/** |
81 |
|
|
* Overrides the {@link java.lang.Object#toString() Object.toString()} |
82 |
|
|
* method to provide clean logging (every class should have this). |
83 |
|
|
* |
84 |
tdb |
1.14 |
* This uses the uk.org.iscream.cms.util.NameFormat class |
85 |
ajm |
1.2 |
* to format the toString() |
86 |
|
|
* |
87 |
|
|
* @return the name of this class and its CVS revision |
88 |
|
|
*/ |
89 |
|
|
public String toString() { |
90 |
|
|
return FormatName.getName( |
91 |
|
|
_name, |
92 |
|
|
getClass().getName(), |
93 |
|
|
REVISION); |
94 |
|
|
} |
95 |
|
|
|
96 |
|
|
/** |
97 |
|
|
* return the String representation of what the filter does |
98 |
|
|
*/ |
99 |
|
|
public String getDescription(){ |
100 |
|
|
return DESC; |
101 |
|
|
} |
102 |
|
|
|
103 |
|
|
//---PRIVATE METHODS--- |
104 |
|
|
|
105 |
|
|
//---ACCESSOR/MUTATOR METHODS--- |
106 |
|
|
|
107 |
|
|
//---ATTRIBUTES--- |
108 |
|
|
|
109 |
|
|
/** |
110 |
|
|
* This is the friendly identifier of the |
111 |
|
|
* component this class is running in. |
112 |
|
|
* eg, a Filter may be called "filter1", |
113 |
|
|
* If this class does not have an owning |
114 |
|
|
* component, a name from the configuration |
115 |
|
|
* can be placed here. This name could also |
116 |
|
|
* be changed to null for utility classes. |
117 |
|
|
*/ |
118 |
|
|
private String _name = FilterMain.NAME; |
119 |
|
|
|
120 |
|
|
/** |
121 |
|
|
* This holds a reference to the |
122 |
|
|
* system logger that is being used. |
123 |
|
|
*/ |
124 |
|
|
private Logger _logger = ReferenceManager.getInstance().getLogger(); |
125 |
|
|
|
126 |
|
|
//---STATIC ATTRIBUTES--- |
127 |
|
|
|
128 |
|
|
} |