server/filter/FilterThread.java

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

//---IMPORTS---
import java.io.*;
import java.net.*;
import java.util.*;
import uk.ac.ukc.iscream.core.*;
import uk.ac.ukc.iscream.componentmanager.*;
import uk.ac.ukc.iscream.filter.*;
import uk.ac.ukc.iscream.util.*;

/**
 * Handle an incoming packet as a separate thread.
 * Passes the data through various plugins, then 
 * passes it on to the parent filter.
 *
 * Now grabs data from a single queue, rather than
 * waiting to be contacted.
 *
 * @author  $Author: tdb1 $
 * @version $Id: FilterThread.java,v 1.27 2001/03/13 02:19:46 tdb1 Exp $
 */
public class FilterThread extends Thread{

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.27 $";
    
//---STATIC METHODS---

//---CONSTRUCTORS---
   
    /**
     * Constructs an instance of a FilterThread
     *
     * @param queue the Queue this filter is using
     */
    public FilterThread(Queue queue){
        // set the Thread name
        setName("filter.FilterThread");
        
        _queue = queue;
        _logger.write(toString(), Logger.SYSINIT, "created");
    }

//---PUBLIC METHODS---

    /**
     * Runs the thread, getting data from the Queue and
     * sending it on to the parent filter.
     */
    public void run(){
        // setup the XMLPacketMaker
        XMLPacketMaker xmlPacketMaker = new XMLPacketMaker();
        // get a queue for ourselves
        int n = _queue.getQueue();
        // keep these out here, saves recreating the object
        String xml = null;
        while(true) {
            // get a String of xml
            try {
                xml = (String) _queue.get(n);
            }
            catch (InvalidQueueException e) {
                _logger.write(toString(), Logger.ERROR, "Queue error: "+e);
            }
            
            // Get a string without any null characters in it.
            //  -- maybe String.trim() would be better here ?
            if (xml.indexOf(0) != -1) {
                xml = xml.substring(0, xml.indexOf(0));
            }
            else {
                xml = xml.substring(0, xml.length());
            }
            
            // Bundle the XML all on one line (saves space and simplifies
            // the protocol between clientinterface and client).
            StringTokenizer tokenizer = new StringTokenizer(new String(xml), "\n");
            xml = "";
            while (tokenizer.hasMoreTokens()) {
                xml += tokenizer.nextToken();
            }
            
            // Use XMLPacketMaker to make an XMLPacket object.
            XMLPacket packet = null;
            try {
                packet = xmlPacketMaker.createXMLPacket(xml);
            } catch(InvalidXMLException e) {
                _logger.write(toString(), Logger.ERROR, "Invalid XML: "+e);
                // skip the rest of this loop iteration
                continue;
            }
            
            // get parent
            Filter parent;
            try {
                String parentFilterName = ConfigurationProxy.getInstance().getProperty(FilterMain.NAME, "Filter.parentFilter");
                parent = FilterHelper.narrow(_refman.getCORBARef("iscream.Filter." + parentFilterName));
            } catch (PropertyNotFoundException e) {
                continue;
            }
                    
            // XMLPacket is ok, run filters...
            if(PluginFilterManager.getInstance().runFilters(packet)) {
                // and pass it on...
                parent.receiveXML(xml);
            }
            else {
                // ... or filtered it
                _logger.write(toString(), Logger.DEBUG, "An XML packet was sucessfully filtered from the system.");
            }
        }
    }

    /**
     * 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);
    }

//---PRIVATE METHODS---

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

//---ATTRIBUTES---
    
    /**
     * The Queue object
     */
    Queue _queue;
    
    /**
     * 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();

    /**
     * A reference to the reference manager in use
     */
    private ReferenceManager _refman = ReferenceManager.getInstance();

//---STATIC ATTRIBUTES---

}
Revision:	1.28
Committed:	Tue Mar 13 16:25:57 2001 UTC (23 years, 2 months ago) by tdb
Branch:	MAIN
Changes since 1.27:	+20 -13 lines
Log Message:	Modified to use the ConfigurationProxy. Also took the opportunity to fix some of the issues with TCP communicates - specifically checking for nulls. This makes the configuration more dynamic, but do note that the TCP/UDP ports are only set on startup. This is because it would require lots of extra work to "change" the ports that the Filter is bound to on the fly.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.ac.ukc.iscream.filter;
3
4	//---IMPORTS---
5	import java.io.*;
6	import java.net.*;
7	import java.util.*;
8	import uk.ac.ukc.iscream.core.*;
9	import uk.ac.ukc.iscream.componentmanager.*;
10	import uk.ac.ukc.iscream.filter.*;
11	import uk.ac.ukc.iscream.util.*;
12
13	/**
14	* Handle an incoming packet as a separate thread.
15	* Passes the data through various plugins, then
16	* passes it on to the parent filter.
17	*
18	* Now grabs data from a single queue, rather than
19	* waiting to be contacted.
20	*
21	* @author $Author: tdb1 $
22	* @version $Id: FilterThread.java,v 1.27 2001/03/13 02:19:46 tdb1 Exp $
23	*/
24	public class FilterThread extends Thread{
25
26	//---FINAL ATTRIBUTES---
27
28	/**
29	* The current CVS revision of this class
30	*/
31	public final String REVISION = "$Revision: 1.27 $";
32
33	//---STATIC METHODS---
34
35	//---CONSTRUCTORS---
36
37	/**
38	* Constructs an instance of a FilterThread
39	*
40	* @param queue the Queue this filter is using
41	*/
42	public FilterThread(Queue queue){
43	// set the Thread name
44	setName("filter.FilterThread");
45
46	_queue = queue;
47	_logger.write(toString(), Logger.SYSINIT, "created");
48	}
49
50	//---PUBLIC METHODS---
51
52	/**
53	* Runs the thread, getting data from the Queue and
54	* sending it on to the parent filter.
55	*/
56	public void run(){
57	// setup the XMLPacketMaker
58	XMLPacketMaker xmlPacketMaker = new XMLPacketMaker();
59	// get a queue for ourselves
60	int n = _queue.getQueue();
61	// keep these out here, saves recreating the object
62	String xml = null;
63	while(true) {
64	// get a String of xml
65	try {
66	xml = (String) _queue.get(n);
67	}
68	catch (InvalidQueueException e) {
69	_logger.write(toString(), Logger.ERROR, "Queue error: "+e);
70	}
71
72	// Get a string without any null characters in it.
73	// -- maybe String.trim() would be better here ?
74	if (xml.indexOf(0) != -1) {
75	xml = xml.substring(0, xml.indexOf(0));
76	}
77	else {
78	xml = xml.substring(0, xml.length());
79	}
80
81	// Bundle the XML all on one line (saves space and simplifies
82	// the protocol between clientinterface and client).
83	StringTokenizer tokenizer = new StringTokenizer(new String(xml), "\n");
84	xml = "";
85	while (tokenizer.hasMoreTokens()) {
86	xml += tokenizer.nextToken();
87	}
88
89	// Use XMLPacketMaker to make an XMLPacket object.
90	XMLPacket packet = null;
91	try {
92	packet = xmlPacketMaker.createXMLPacket(xml);
93	} catch(InvalidXMLException e) {
94	_logger.write(toString(), Logger.ERROR, "Invalid XML: "+e);
95	// skip the rest of this loop iteration
96	continue;
97	}
98
99	// get parent
100	Filter parent;
101	try {
102	String parentFilterName = ConfigurationProxy.getInstance().getProperty(FilterMain.NAME, "Filter.parentFilter");
103	parent = FilterHelper.narrow(_refman.getCORBARef("iscream.Filter." + parentFilterName));
104	} catch (PropertyNotFoundException e) {
105	continue;
106	}
107
108	// XMLPacket is ok, run filters...
109	if(PluginFilterManager.getInstance().runFilters(packet)) {
110	// and pass it on...
111	parent.receiveXML(xml);
112	}
113	else {
114	// ... or filtered it
115	_logger.write(toString(), Logger.DEBUG, "An XML packet was sucessfully filtered from the system.");
116	}
117	}
118	}
119
120	/**
121	* Overrides the {@link java.lang.Object#toString() Object.toString()}
122	* method to provide clean logging (every class should have this).
123	*
124	* This uses the uk.ac.ukc.iscream.util.NameFormat class
125	* to format the toString()
126	*
127	* @return the name of this class and its CVS revision
128	*/
129	public String toString() {
130	return FormatName.getName(
131	_name,
132	getClass().getName(),
133	REVISION);
134	}
135
136	//---PRIVATE METHODS---
137
138	//---ACCESSOR/MUTATOR METHODS---
139
140	//---ATTRIBUTES---
141
142	/**
143	* The Queue object
144	*/
145	Queue _queue;
146
147	/**
148	* This is the friendly identifier of the
149	* component this class is running in.
150	* eg, a Filter may be called "filter1",
151	* If this class does not have an owning
152	* component, a name from the configuration
153	* can be placed here. This name could also
154	* be changed to null for utility classes.
155	*/
156	private String _name = FilterMain.NAME;
157
158	/**
159	* This holds a reference to the
160	* system logger that is being used.
161	*/
162	private Logger _logger = ReferenceManager.getInstance().getLogger();
163
164	/**
165	* A reference to the reference manager in use
166	*/
167	private ReferenceManager _refman = ReferenceManager.getInstance();
168
169	//---STATIC ATTRIBUTES---
170
171	}