1 |
+ |
/* |
2 |
+ |
* i-scream central monitoring system |
3 |
+ |
* http://www.i-scream.org.uk |
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 java.io.*; |
26 |
|
import java.net.*; |
27 |
|
import java.util.*; |
28 |
< |
import uk.ac.ukc.iscream.filter.*; |
28 |
> |
import uk.org.iscream.cms.server.core.*; |
29 |
> |
import uk.org.iscream.cms.server.componentmanager.*; |
30 |
> |
import uk.org.iscream.cms.server.filter.*; |
31 |
> |
import uk.org.iscream.cms.server.util.*; |
32 |
|
|
33 |
< |
// Handle an incoming UDP packet as a separate thread. |
33 |
> |
/** |
34 |
> |
* Handle an incoming packet as a separate thread. |
35 |
> |
* Passes the data through various plugins, then |
36 |
> |
* passes it on to the parent filter. |
37 |
> |
* |
38 |
> |
* Now grabs data from a single queue, rather than |
39 |
> |
* waiting to be contacted. |
40 |
> |
* |
41 |
> |
* @author $Author$ |
42 |
> |
* @version $Id$ |
43 |
> |
*/ |
44 |
|
public class FilterThread extends Thread{ |
45 |
|
|
46 |
< |
// Class constructor. Obtains the byte[] from a DatagramPacket. |
47 |
< |
public FilterThread(Filter parent, DatagramPacket packet){ |
48 |
< |
this.parent = parent; |
49 |
< |
this.rawPacket = packet.getData(); |
50 |
< |
} |
46 |
> |
//---FINAL ATTRIBUTES--- |
47 |
> |
|
48 |
> |
/** |
49 |
> |
* The current CVS revision of this class |
50 |
> |
*/ |
51 |
> |
public final String REVISION = "$Revision$"; |
52 |
|
|
53 |
< |
// Class constructor for passing XML Strings. |
54 |
< |
public FilterThread(Filter parent, String xml){ |
55 |
< |
this.parent = parent; |
56 |
< |
this.rawPacket = xml.getBytes(); |
53 |
> |
//---STATIC METHODS--- |
54 |
> |
|
55 |
> |
//---CONSTRUCTORS--- |
56 |
> |
|
57 |
> |
/** |
58 |
> |
* Constructs an instance of a FilterThread |
59 |
> |
* |
60 |
> |
* @param queue the Queue this filter is using |
61 |
> |
*/ |
62 |
> |
public FilterThread(Queue queue){ |
63 |
> |
// set the Thread name |
64 |
> |
setName("filter.FilterThread"); |
65 |
> |
|
66 |
> |
_queue = queue; |
67 |
> |
_logger.write(toString(), Logger.SYSINIT, "created"); |
68 |
|
} |
69 |
< |
|
69 |
> |
|
70 |
> |
//---PUBLIC METHODS--- |
71 |
> |
|
72 |
> |
/** |
73 |
> |
* Runs the thread, getting data from the Queue and |
74 |
> |
* sending it on to the parent filter. |
75 |
> |
*/ |
76 |
|
public void run(){ |
77 |
< |
|
78 |
< |
// Get a string without any null characters in it. |
79 |
< |
String xml = new String(rawPacket); |
80 |
< |
if (xml.indexOf(0) != -1) { |
81 |
< |
xml = xml.substring(0, xml.indexOf(0)); |
77 |
> |
// get a queue for ourselves |
78 |
> |
int n = _queue.getQueue(); |
79 |
> |
// keep these out here, saves recreating the object |
80 |
> |
String xml = null; |
81 |
> |
String parentFilterName = ""; |
82 |
> |
Filter parent = null; |
83 |
> |
while(true) { |
84 |
> |
// get a String of xml |
85 |
> |
try { |
86 |
> |
xml = (String) _queue.get(n); |
87 |
> |
} |
88 |
> |
catch (InvalidQueueException e) { |
89 |
> |
_logger.write(toString(), Logger.ERROR, "Queue error: "+e); |
90 |
> |
} |
91 |
> |
|
92 |
> |
// Get a string without any null characters in it. |
93 |
> |
// -- maybe String.trim() would be better here ? |
94 |
> |
if (xml.indexOf(0) != -1) { |
95 |
> |
xml = xml.substring(0, xml.indexOf(0)); |
96 |
> |
} |
97 |
> |
|
98 |
> |
// Bundle the XML all on one line (saves space and simplifies |
99 |
> |
// the protocol between clientinterface and client). |
100 |
> |
StringTokenizer tokenizer = new StringTokenizer(new String(xml), "\n"); |
101 |
> |
xml = ""; |
102 |
> |
while (tokenizer.hasMoreTokens()) { |
103 |
> |
xml += tokenizer.nextToken(); |
104 |
> |
} |
105 |
> |
|
106 |
> |
// Get an XMLPacket from the XMLCache. |
107 |
> |
XMLPacket packet = null; |
108 |
> |
try { |
109 |
> |
packet = _xmlCache.getXMLPacket(xml); |
110 |
> |
} catch(InvalidXMLException e) { |
111 |
> |
_logger.write(toString(), Logger.ERROR, "Invalid XML: "+e); |
112 |
> |
// skip the rest of this loop iteration |
113 |
> |
continue; |
114 |
> |
} |
115 |
> |
|
116 |
> |
// get parent |
117 |
> |
try { |
118 |
> |
String newParent = ConfigurationProxy.getInstance().getProperty("Filter." + FilterMain.NAME, "Filter.parentFilter"); |
119 |
> |
if(!parentFilterName.equals(newParent)) { |
120 |
> |
parentFilterName = newParent; |
121 |
> |
parent = FilterHelper.narrow(_refman.getCORBARef("iscream.Filter\\." + parentFilterName)); |
122 |
> |
_logger.write(toString(), Logger.DEBUG, "Parent filter changed to: "+parentFilterName); |
123 |
> |
} |
124 |
> |
} catch (PropertyNotFoundException e) { |
125 |
> |
continue; |
126 |
> |
} |
127 |
> |
|
128 |
> |
// XMLPacket is ok, run filters... |
129 |
> |
if(PluginFilterManager.getInstance().runFilters(packet)) { |
130 |
> |
// and pass it on... |
131 |
> |
parent.receiveXML(xml); |
132 |
> |
} |
133 |
> |
else { |
134 |
> |
// ... or filtered it |
135 |
> |
_logger.write(toString(), Logger.DEBUG, "An XML packet was sucessfully filtered from the system."); |
136 |
> |
} |
137 |
|
} |
138 |
< |
else { |
29 |
< |
xml = xml.substring(0, xml.length()); |
30 |
< |
} |
31 |
< |
System.out.println(xml); |
138 |
> |
} |
139 |
|
|
140 |
< |
// Use my XMLPacketMaker to make an XMLPacket object. |
141 |
< |
XMLPacketMaker xmlPacketMaker = new XMLPacketMaker(xml); |
142 |
< |
XMLPacket packet = xmlPacketMaker.createXMLPacket(); |
143 |
< |
|
144 |
< |
if (packet == null){ |
145 |
< |
System.out.println("UDPReaderThread - A null XMLPacket was returned, I think I'll ignore it!"); |
146 |
< |
return; |
147 |
< |
} |
148 |
< |
System.out.println("UDPReaderThread - An XML Packet was read sucessfully: -"); |
149 |
< |
packet.printAll(); |
150 |
< |
// Now do something with this XMLPacket!!! |
151 |
< |
// .... let's try this... |
152 |
< |
parent.receiveXML(xml); |
153 |
< |
|
140 |
> |
/** |
141 |
> |
* Overrides the {@link java.lang.Object#toString() Object.toString()} |
142 |
> |
* method to provide clean logging (every class should have this). |
143 |
> |
* |
144 |
> |
* This uses the uk.org.iscream.cms.server.util.NameFormat class |
145 |
> |
* to format the toString() |
146 |
> |
* |
147 |
> |
* @return the name of this class and its CVS revision |
148 |
> |
*/ |
149 |
> |
public String toString() { |
150 |
> |
return FormatName.getName( |
151 |
> |
_name, |
152 |
> |
getClass().getName(), |
153 |
> |
REVISION); |
154 |
|
} |
155 |
+ |
|
156 |
+ |
//---PRIVATE METHODS--- |
157 |
+ |
|
158 |
+ |
//---ACCESSOR/MUTATOR METHODS--- |
159 |
+ |
|
160 |
+ |
//---ATTRIBUTES--- |
161 |
|
|
162 |
< |
Filter parent; |
163 |
< |
byte[] rawPacket; |
162 |
> |
/** |
163 |
> |
* The Queue object |
164 |
> |
*/ |
165 |
> |
Queue _queue; |
166 |
> |
|
167 |
> |
/** |
168 |
> |
* This is the friendly identifier of the |
169 |
> |
* component this class is running in. |
170 |
> |
* eg, a Filter may be called "filter1", |
171 |
> |
* If this class does not have an owning |
172 |
> |
* component, a name from the configuration |
173 |
> |
* can be placed here. This name could also |
174 |
> |
* be changed to null for utility classes. |
175 |
> |
*/ |
176 |
> |
private String _name = FilterMain.NAME; |
177 |
> |
|
178 |
> |
/** |
179 |
> |
* This holds a reference to the |
180 |
> |
* system logger that is being used. |
181 |
> |
*/ |
182 |
> |
private Logger _logger = ReferenceManager.getInstance().getLogger(); |
183 |
> |
|
184 |
> |
/** |
185 |
> |
* A reference to the reference manager in use |
186 |
> |
*/ |
187 |
> |
private ReferenceManager _refman = ReferenceManager.getInstance(); |
188 |
> |
|
189 |
> |
/** |
190 |
> |
* A reference to the XMLCache in use |
191 |
> |
*/ |
192 |
> |
private XMLCache _xmlCache = XMLCache.getInstance(); |
193 |
> |
|
194 |
> |
//---STATIC ATTRIBUTES--- |
195 |
> |
|
196 |
|
} |