server/filtermanager/HostInit.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.filtermanager;

//---IMPORTS---
import uk.org.iscream.cms.server.core.*;
import uk.org.iscream.cms.server.filter.*;
import uk.org.iscream.cms.util.*;
import uk.org.iscream.cms.server.componentmanager.*;
import java.net.*;
import java.io.*;
import java.util.*;

/**
 * Handles setting up a host.
 * This class provides a host with appropriate configuration
 * and a reference to a Filter to which it should pass data.
 *
 * @author  $Author: tdb $
 * @version $Id: HostInit.java,v 1.40 2004/08/01 10:41:05 tdb Exp $
 */
class HostInit extends Thread {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

    /**
     * Construct a new HostInit.
     *
     * @param socket The socket to which the host is connected
     */
    public HostInit(Socket socket) throws IOException {
        // set the Thread name
        setName("filtermanager.HostInit");
        
        _socket = socket;
        // setup reader & writer
        _socketIn = new BufferedReader(new InputStreamReader(_socket.getInputStream()));
        _socketOut = new PrintWriter(_socket.getOutputStream(), true);
        _logger.write(toString(), Logger.SYSINIT, "created");
    }
    
//---PUBLIC METHODS---

    /**
     * Main method in this class, which handles communicating with
     * the host to determine it's setup.
     */
    public void run() {
        // get a hook on the config proxy
        ConfigurationProxy cp = ConfigurationProxy.getInstance();
        // this is our config name
        String configName = "Host." + _socket.getInetAddress().getHostName().toLowerCase();
        try {
            // look for a command:
            // STARTCONFIG - to get a configuration
            // CHECKCONFIG - to check a configuration
            // END - to finish
            String cmd = getInBound();
            while(!cmd.equals("END")) {
                if(cmd.equals("STARTCONFIG")) {
                    // respond to STARTCONFIG
                    send("OK");
                    
                    // try for LASTMODIFIED
                    getInBound("LASTMODIFIED");
                    send("" + cp.getLastModified(configName));
                    
                    // try for FILELIST
                    getInBound("FILELIST");
                    send(cp.getFileList(configName));
                    
                    // try for FQDN
                    getInBound("FQDN");
                    send(_socket.getInetAddress().getHostName().toLowerCase());
                    
                    // try for IP
                    getInBound("IP");
                    send(_socket.getInetAddress().getHostAddress());
                    
                    // get properties
                    String reqProperty = getInBound();
                    while(!reqProperty.equals("ENDCONFIG")) {
                        // get the property
                        try {
                            String returnedProperty = cp.getProperty(configName, "Host."+reqProperty);
                            send(returnedProperty);
                        } catch (PropertyNotFoundException e) {
                            send("ERROR");
                        }
                        // get the next request
                        reqProperty = _socketIn.readLine();
                    }
                    _logger.write(toString(), Logger.SYSMSG, "configured host");
                    send("OK");
                    
                    // get filter reference
                    getInBound("FILTER");
                    // send info
                    String filterList = cp.getProperty(configName, "Host.filter");
                    FilterInfo filterInfoRef = null;
                    String filter = null;
                    StringTokenizer st = new StringTokenizer(filterList, ";");
                    while (filterInfoRef==null && st.hasMoreTokens()) {
                        filter = st.nextToken();
                        _logger.write(toString(), Logger.DEBUG, " looking for filter- " + filter);
                        try {
                            filterInfoRef = FilterInfoHelper.narrow(ReferenceManager.getInstance().getCORBARef("iscream.FilterInfo\\." + filter));
                        } catch (ComponentCORBAException e) {
                            _logger.write(toString(), Logger.DEBUG, " unable to find filter- " + filter);
                        }
                    }
                    
                    // hopefully we found a filter
                    if(filterInfoRef != null) {
                        _logger.write(toString(), Logger.DEBUG, " found filter- " + filter);
                        try {
                            // tell the host about it...
                            send(filterInfoRef.getHostName() + ";"
                            + filterInfoRef.getUDPPort());
                        }
                        catch(org.omg.CORBA.COMM_FAILURE e) {
                            // failed to talk to filter, lets signal an error
                            send("ERROR");
                            throw new IOException("error communicating with filter - " + e);
                        }
                    }
                    else {
                        // ...or throw a wobbly (and tell the host!)
                        send("ERROR");
                        throw new IOException("unable to find filter for host");
                    }
                    
                }
                else if(cmd.equals("CHECKCONFIG")) {
                    // respond to CHECKCONFIG
                    send("OK");
                    
                    // try for {filelist}
                    String filelist = getInBound();
                    send("OK");
                    
                    // try for {lastModified}
                    String lastModified = getInBound();
                    long lastmod;
                    try {
                        lastmod = Long.parseLong(lastModified);
                    }
                    catch(NumberFormatException e) {
                        send("ERROR");
                        throw new IOException("Last Modified invalid: " + e);
                    }
                    
                    // check to see if a config update has happen
                    boolean newConfig = _configManager.isModified(filelist, lastmod);
                    if(newConfig) {
                        // new config !
                        send("EXPIRED");
                    }
                    else {
                        // nothing has changed
                        send("OK");
                    }
                }
                else {
                    send("ERROR");
                }
                // get the next command
                cmd = getInBound();
            }
            // respond to END
            send("OK");
            
        } catch (Exception e) {
            _logger.write(toString(), Logger.ERROR, "ERROR - " + e);
        }
        
        // Disconnect streams & socket
        try {
            _socketIn.close();
            _socketOut.close();
            _socket.close();
        } catch (IOException e) {
            _logger.write(toString(), Logger.ERROR, "exception on socket close");
        }
        _logger.write(toString(), Logger.SYSMSG, "finished");
    }
    
    /**
     * 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---

    private String getInBound(String expected) throws IOException {
        // grab the input
        String inBound = getInBound();
        // check if it's what we're expecting
        if(!inBound.equals(expected)) {
            send("ERROR");
            throw new IOException("protocol error - expected:"+expected+" got:" + inBound);
        }
        // it should be ok then
        return inBound;
    }
    
    private String getInBound() throws IOException {
        // grab the input
        String inBound = _socketIn.readLine();
        // check for null's, likely disconnection
        if(inBound == null) {
            throw new IOException("got null from host, maybe it died");
        }
        // it's a valid message it seems
        return inBound;
    }

        /* Use this instead of println. println under windows terminates the lines
         * in \c\n which is not the expected result for the ihost client.
         */
        private void send(String data) {
                _socketOut.print(data + "\n");
                _socketOut.flush();
        }

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

//---ATTRIBUTES---

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = ReferenceManager.getInstance().getLogger();
    
    /**
     * A reference to the Configuration Manager the system is using
     */
    private ConfigurationManager _configManager = ReferenceManager.getInstance().getCM();
    
    /**
     * 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 = FilterManager.NAME;
    
    /** 
     * The socket this class uses
     */
    private Socket _socket;

    /**
     * Used for the input stream of this socket
     */
    private BufferedReader _socketIn;
    
    /**
     * Used for the output stream of this socket
     */
    private PrintWriter _socketOut;

//---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:	+29 -21 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.filtermanager;
23
24	//---IMPORTS---
25	import uk.org.iscream.cms.server.core.*;
26	import uk.org.iscream.cms.server.filter.*;
27	import uk.org.iscream.cms.util.*;
28	import uk.org.iscream.cms.server.componentmanager.*;
29	import java.net.*;
30	import java.io.*;
31	import java.util.*;
32
33	/**
34	* Handles setting up a host.
35	* This class provides a host with appropriate configuration
36	* and a reference to a Filter to which it should pass data.
37	*
38	* @author $Author: tdb $
39	* @version $Id: HostInit.java,v 1.40 2004/08/01 10:41:05 tdb Exp $
40	*/
41	class HostInit extends Thread {
42
43	//---FINAL ATTRIBUTES---
44
45	/**
46	* The current CVS revision of this class
47	*/
48	public final String REVISION = "$Revision: 1.40 $";
49
50	//---STATIC METHODS---
51
52	//---CONSTRUCTORS---
53
54	/**
55	* Construct a new HostInit.
56	*
57	* @param socket The socket to which the host is connected
58	*/
59	public HostInit(Socket socket) throws IOException {
60	// set the Thread name
61	setName("filtermanager.HostInit");
62
63	_socket = socket;
64	// setup reader & writer
65	_socketIn = new BufferedReader(new InputStreamReader(_socket.getInputStream()));
66	_socketOut = new PrintWriter(_socket.getOutputStream(), true);
67	_logger.write(toString(), Logger.SYSINIT, "created");
68	}
69
70	//---PUBLIC METHODS---
71
72	/**
73	* Main method in this class, which handles communicating with
74	* the host to determine it's setup.
75	*/
76	public void run() {
77	// get a hook on the config proxy
78	ConfigurationProxy cp = ConfigurationProxy.getInstance();
79	// this is our config name
80	String configName = "Host." + _socket.getInetAddress().getHostName().toLowerCase();
81	try {
82	// look for a command:
83	// STARTCONFIG - to get a configuration
84	// CHECKCONFIG - to check a configuration
85	// END - to finish
86	String cmd = getInBound();
87	while(!cmd.equals("END")) {
88	if(cmd.equals("STARTCONFIG")) {
89	// respond to STARTCONFIG
90	send("OK");
91
92	// try for LASTMODIFIED
93	getInBound("LASTMODIFIED");
94	send("" + cp.getLastModified(configName));
95
96	// try for FILELIST
97	getInBound("FILELIST");
98	send(cp.getFileList(configName));
99
100	// try for FQDN
101	getInBound("FQDN");
102	send(_socket.getInetAddress().getHostName().toLowerCase());
103
104	// try for IP
105	getInBound("IP");
106	send(_socket.getInetAddress().getHostAddress());
107
108	// get properties
109	String reqProperty = getInBound();
110	while(!reqProperty.equals("ENDCONFIG")) {
111	// get the property
112	try {
113	String returnedProperty = cp.getProperty(configName, "Host."+reqProperty);
114	send(returnedProperty);
115	} catch (PropertyNotFoundException e) {
116	send("ERROR");
117	}
118	// get the next request
119	reqProperty = _socketIn.readLine();
120	}
121	_logger.write(toString(), Logger.SYSMSG, "configured host");
122	send("OK");
123
124	// get filter reference
125	getInBound("FILTER");
126	// send info
127	String filterList = cp.getProperty(configName, "Host.filter");
128	FilterInfo filterInfoRef = null;
129	String filter = null;
130	StringTokenizer st = new StringTokenizer(filterList, ";");
131	while (filterInfoRef==null && st.hasMoreTokens()) {
132	filter = st.nextToken();
133	_logger.write(toString(), Logger.DEBUG, " looking for filter- " + filter);
134	try {
135	filterInfoRef = FilterInfoHelper.narrow(ReferenceManager.getInstance().getCORBARef("iscream.FilterInfo\\." + filter));
136	} catch (ComponentCORBAException e) {
137	_logger.write(toString(), Logger.DEBUG, " unable to find filter- " + filter);
138	}
139	}
140
141	// hopefully we found a filter
142	if(filterInfoRef != null) {
143	_logger.write(toString(), Logger.DEBUG, " found filter- " + filter);
144	try {
145	// tell the host about it...
146	send(filterInfoRef.getHostName() + ";"
147	+ filterInfoRef.getUDPPort());
148	}
149	catch(org.omg.CORBA.COMM_FAILURE e) {
150	// failed to talk to filter, lets signal an error
151	send("ERROR");
152	throw new IOException("error communicating with filter - " + e);
153	}
154	}
155	else {
156	// ...or throw a wobbly (and tell the host!)
157	send("ERROR");
158	throw new IOException("unable to find filter for host");
159	}
160
161	}
162	else if(cmd.equals("CHECKCONFIG")) {
163	// respond to CHECKCONFIG
164	send("OK");
165
166	// try for {filelist}
167	String filelist = getInBound();
168	send("OK");
169
170	// try for {lastModified}
171	String lastModified = getInBound();
172	long lastmod;
173	try {
174	lastmod = Long.parseLong(lastModified);
175	}
176	catch(NumberFormatException e) {
177	send("ERROR");
178	throw new IOException("Last Modified invalid: " + e);
179	}
180
181	// check to see if a config update has happen
182	boolean newConfig = _configManager.isModified(filelist, lastmod);
183	if(newConfig) {
184	// new config !
185	send("EXPIRED");
186	}
187	else {
188	// nothing has changed
189	send("OK");
190	}
191	}
192	else {
193	send("ERROR");
194	}
195	// get the next command
196	cmd = getInBound();
197	}
198	// respond to END
199	send("OK");
200
201	} catch (Exception e) {
202	_logger.write(toString(), Logger.ERROR, "ERROR - " + e);
203	}
204
205	// Disconnect streams & socket
206	try {
207	_socketIn.close();
208	_socketOut.close();
209	_socket.close();
210	} catch (IOException e) {
211	_logger.write(toString(), Logger.ERROR, "exception on socket close");
212	}
213	_logger.write(toString(), Logger.SYSMSG, "finished");
214	}
215
216	/**
217	* Overrides the {@link java.lang.Object#toString() Object.toString()}
218	* method to provide clean logging (every class should have this).
219	*
220	* This uses the uk.org.iscream.cms.util.NameFormat class
221	* to format the toString()
222	*
223	* @return the name of this class and its CVS revision
224	*/
225	public String toString() {
226	return FormatName.getName(
227	_name,
228	getClass().getName(),
229	REVISION);
230	}
231
232	//---PRIVATE METHODS---
233
234	private String getInBound(String expected) throws IOException {
235	// grab the input
236	String inBound = getInBound();
237	// check if it's what we're expecting
238	if(!inBound.equals(expected)) {
239	send("ERROR");
240	throw new IOException("protocol error - expected:"+expected+" got:" + inBound);
241	}
242	// it should be ok then
243	return inBound;
244	}
245
246	private String getInBound() throws IOException {
247	// grab the input
248	String inBound = _socketIn.readLine();
249	// check for null's, likely disconnection
250	if(inBound == null) {
251	throw new IOException("got null from host, maybe it died");
252	}
253	// it's a valid message it seems
254	return inBound;
255	}
256
257	/* Use this instead of println. println under windows terminates the lines
258	* in \c\n which is not the expected result for the ihost client.
259	*/
260	private void send(String data) {
261	_socketOut.print(data + "\n");
262	_socketOut.flush();
263	}
264
265	//---ACCESSOR/MUTATOR METHODS---
266
267	//---ATTRIBUTES---
268
269	/**
270	* This holds a reference to the
271	* system logger that is being used.
272	*/
273	private Logger _logger = ReferenceManager.getInstance().getLogger();
274
275	/**
276	* A reference to the Configuration Manager the system is using
277	*/
278	private ConfigurationManager _configManager = ReferenceManager.getInstance().getCM();
279
280	/**
281	* This is the friendly identifier of the
282	* component this class is running in.
283	* eg, a Filter may be called "filter1",
284	* If this class does not have an owning
285	* component, a name from the configuration
286	* can be placed here. This name could also
287	* be changed to null for utility classes.
288	*/
289	private String _name = FilterManager.NAME;
290
291	/**
292	* The socket this class uses
293	*/
294	private Socket _socket;
295
296	/**
297	* Used for the input stream of this socket
298	*/
299	private BufferedReader _socketIn;
300
301	/**
302	* Used for the output stream of this socket
303	*/
304	private PrintWriter _socketOut;
305
306	//---STATIC ATTRIBUTES---
307
308	}