server/filter/FilterThread.java

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.server.filter;

//---IMPORTS---
import java.io.*;
import java.net.*;
import java.util.*;
import uk.org.iscream.cms.server.core.*;
import uk.org.iscream.cms.server.componentmanager.*;
import uk.org.iscream.cms.server.filter.*;
import uk.org.iscream.cms.server.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: tdb $
 * @version $Id: FilterThread.java,v 1.32 2001/05/29 17:02:35 tdb Exp $
 */
public class FilterThread extends Thread{

//---FINAL ATTRIBUTES---

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