server/filter/FilterThread.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org
 * Copyright (C) 2000-2002 i-scream
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

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

//---IMPORTS---
import java.io.*;
import java.net.*;
import java.util.StringTokenizer;
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.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.40 2004/08/01 10:40:59 tdb Exp $
 */
public class FilterThread extends Thread{

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.40 $";
    
//---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(){
        // 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));
            }
            
            // 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();
            }
            
            // Get an XMLPacket from the XMLCache.
            XMLPacket packet = null;
            try {
                packet = _xmlCache.getXMLPacket(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.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();
    
    /**
     * A reference to the XMLCache in use
     */
    private XMLCache _xmlCache = XMLCache.getInstance();

//---STATIC ATTRIBUTES---

}
Revision:	1.41
Committed:	Sun Sep 25 09:57:42 2005 UTC (18 years, 7 months ago) by tdb
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.40:	+3 -3 lines
Log Message:	Fix compile problems on j2se 1.5 - our Queue class conflicted with one in java.util. Also fix an API issue when running the server on Windows - the println method sends '\r\n' on Windows instead of '\n' on Unix, which confuses applications such as ihost. Patch provided by: skel
#	Content
1	/*
2	* i-scream central monitoring system
3	* http://www.i-scream.org
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.StringTokenizer;
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.util.*;
32
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: tdb $
42	* @version $Id: FilterThread.java,v 1.40 2004/08/01 10:40:59 tdb Exp $
43	*/
44	public class FilterThread extends Thread{
45
46	//---FINAL ATTRIBUTES---
47
48	/**
49	* The current CVS revision of this class
50	*/
51	public final String REVISION = "$Revision: 1.40 $";
52
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
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	// 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	}
139
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.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	/**
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	}