server/filtermanager/HostInit.java

/* 
 * i-scream central monitoring system
 * 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.server.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.29 2002/03/22 10:43:06 tdb Exp $
 */
class HostInit extends Thread {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.29 $";
    
//---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 {
            // try for STARTCONFIG
            getInBound("STARTCONFIG");
            _socketOut.println("OK");
            
            // try for LASTMODIFIED
            getInBound("LASTMODIFIED");
            _socketOut.println(cp.getLastModified(configName));
            
            // try for FILELIST
            getInBound("FILELIST");
            _socketOut.println(cp.getFileList(configName));
            
            // try for FQDN
            getInBound("FQDN");
            _socketOut.println(_socket.getInetAddress().getHostName().toLowerCase());
            
            // get properties
            String reqProperty = getInBound();
            while(!reqProperty.equals("ENDCONFIG")) {
                // get the property
                try {
                    String returnedProperty = cp.getProperty(configName, "Host."+reqProperty);
                    _socketOut.println(returnedProperty);
                } catch (PropertyNotFoundException e) {
                    _socketOut.println("ERROR");
                }
                // get the next request
                reqProperty = _socketIn.readLine();
            }
            _logger.write(toString(), Logger.SYSMSG, "configured host");
            _socketOut.println("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);
                // tell the host about it...
                    _socketOut.println(filterInfoRef.getHostName() + ";"
                                     + filterInfoRef.getUDPPort() + ";"
                                     + filterInfoRef.getTCPPort());
                }
                else {
                    // ...or throw a wobbly (and tell the host!)
                    _socketOut.println("ERROR");
                    throw new IOException("unable to find filter for host");
                }
            
            // confirm ok with END
            getInBound("END");
            _socketOut.println("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.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---

    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)) {
            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;
    }

//---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.30
Committed:	Sat May 18 18:16:02 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.29:	+21 -2 lines
Log Message:	i-scream is now licensed under the GPL. I've added the GPL headers to every source file, and put a full copy of the license in the appropriate places. I think I've covered everything. This is going to be a mad commit ;)
#	User	Rev	Content
1	tdb	1.30	/*
2			* i-scream central monitoring system
3			* Copyright (C) 2000-2002 i-scream
4			*
5			* This program is free software; you can redistribute it and/or
6			* modify it under the terms of the GNU General Public License
7			* as published by the Free Software Foundation; either version 2
8			* of the License, or (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			*
15			* You should have received a copy of the GNU General Public License
16			* along with this program; if not, write to the Free Software
17			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18			*/
19
20	tdb	1.1	//---PACKAGE DECLARATION---
21	tdb	1.28	package uk.org.iscream.cms.server.filtermanager;
22	tdb	1.1
23			//---IMPORTS---
24	tdb	1.28	import uk.org.iscream.cms.server.core.*;
25			import uk.org.iscream.cms.server.filter.*;
26			import uk.org.iscream.cms.server.util.*;
27			import uk.org.iscream.cms.server.componentmanager.*;
28	tdb	1.18	import java.net.*;
29	tdb	1.1	import java.io.*;
30	tdb	1.22	import java.util.*;
31	tdb	1.1
32			/**
33	tdb	1.11	* Handles setting up a host.
34	ajm	1.12	* This class provides a host with appropriate configuration
35			* and a reference to a Filter to which it should pass data.
36	tdb	1.1	*
37	tdb	1.29	* @author $Author: tdb $
38	tdb	1.30	* @version $Id: HostInit.java,v 1.29 2002/03/22 10:43:06 tdb Exp $
39	tdb	1.1	*/
40			class HostInit extends Thread {
41
42			//---FINAL ATTRIBUTES---
43
44			/**
45			* The current CVS revision of this class
46			*/
47	tdb	1.30	public final String REVISION = "$Revision: 1.29 $";
48	tdb	1.1
49			//---STATIC METHODS---
50
51			//---CONSTRUCTORS---
52
53	tdb	1.15	/**
54			* Construct a new HostInit.
55			*
56			* @param socket The socket to which the host is connected
57			*/
58	tdb	1.11	public HostInit(Socket socket) throws IOException {
59	tdb	1.25	// set the Thread name
60			setName("filtermanager.HostInit");
61
62	tdb	1.1	_socket = socket;
63	tdb	1.15	// setup reader & writer
64	tdb	1.1	_socketIn = new BufferedReader(new InputStreamReader(_socket.getInputStream()));
65	tdb	1.16	_socketOut = new PrintWriter(_socket.getOutputStream(), true);
66	tdb	1.11	_logger.write(toString(), Logger.SYSINIT, "created");
67	tdb	1.1	}
68
69			//---PUBLIC METHODS---
70
71	tdb	1.15	/**
72			* Main method in this class, which handles communicating with
73			* the host to determine it's setup.
74			*/
75	tdb	1.1	public void run() {
76	tdb	1.26	// get a hook on the config proxy
77			ConfigurationProxy cp = ConfigurationProxy.getInstance();
78			// this is our config name
79			String configName = "Host." + _socket.getInetAddress().getHostName().toLowerCase();
80	tdb	1.1	try {
81	tdb	1.26	// try for STARTCONFIG
82			getInBound("STARTCONFIG");
83			_socketOut.println("OK");
84
85			// try for LASTMODIFIED
86			getInBound("LASTMODIFIED");
87			_socketOut.println(cp.getLastModified(configName));
88
89			// try for FILELIST
90			getInBound("FILELIST");
91			_socketOut.println(cp.getFileList(configName));
92
93			// try for FQDN
94			getInBound("FQDN");
95			_socketOut.println(_socket.getInetAddress().getHostName().toLowerCase());
96
97			// get properties
98			String reqProperty = getInBound();
99			while(!reqProperty.equals("ENDCONFIG")) {
100			// get the property
101			try {
102			String returnedProperty = cp.getProperty(configName, "Host."+reqProperty);
103			_socketOut.println(returnedProperty);
104			} catch (PropertyNotFoundException e) {
105	tdb	1.2	_socketOut.println("ERROR");
106	tdb	1.4	}
107	tdb	1.26	// get the next request
108			reqProperty = _socketIn.readLine();
109			}
110			_logger.write(toString(), Logger.SYSMSG, "configured host");
111			_socketOut.println("OK");
112
113			// get filter reference
114			getInBound("FILTER");
115			// send info
116			String filterList = cp.getProperty(configName, "Host.filter");
117	tdb	1.29	FilterInfo filterInfoRef = null;
118	tdb	1.26	String filter = null;
119			StringTokenizer st = new StringTokenizer(filterList, ";");
120	tdb	1.29	while (filterInfoRef==null && st.hasMoreTokens()) {
121	tdb	1.26	filter = st.nextToken();
122			_logger.write(toString(), Logger.DEBUG, " looking for filter- " + filter);
123			try {
124	tdb	1.29	filterInfoRef = FilterInfoHelper.narrow(ReferenceManager.getInstance().getCORBARef("iscream.FilterInfo." + filter));
125	tdb	1.26	} catch (ComponentCORBAException e) {
126			_logger.write(toString(), Logger.DEBUG, " unable to find filter- " + filter);
127	tdb	1.7	}
128	tdb	1.1	}
129	tdb	1.26
130			// hopefully we found a filter
131	tdb	1.29	if(filterInfoRef != null) {
132	tdb	1.26	_logger.write(toString(), Logger.DEBUG, " found filter- " + filter);
133			// tell the host about it...
134	tdb	1.29	_socketOut.println(filterInfoRef.getHostName() + ";"
135			+ filterInfoRef.getUDPPort() + ";"
136			+ filterInfoRef.getTCPPort());
137	tdb	1.26	}
138			else {
139			// ...or throw a wobbly (and tell the host!)
140			_socketOut.println("ERROR");
141			throw new IOException("unable to find filter for host");
142			}
143
144			// confirm ok with END
145			getInBound("END");
146			_socketOut.println("OK");
147	tdb	1.1
148			} catch (Exception e) {
149	tdb	1.17	_logger.write(toString(), Logger.ERROR, "ERROR - " + e);
150	tdb	1.1	}
151
152			// Disconnect streams & socket
153			try {
154			_socketIn.close();
155			_socketOut.close();
156			_socket.close();
157			} catch (IOException e) {
158	tdb	1.11	_logger.write(toString(), Logger.ERROR, "exception on socket close");
159	tdb	1.1	}
160	tdb	1.11	_logger.write(toString(), Logger.SYSMSG, "finished");
161	tdb	1.1	}
162
163			/**
164			* Overrides the {@link java.lang.Object#toString() Object.toString()}
165			* method to provide clean logging (every class should have this).
166			*
167	tdb	1.28	* This uses the uk.org.iscream.cms.server.util.NameFormat class
168	ajm	1.12	* to format the toString()
169			*
170	tdb	1.1	* @return the name of this class and its CVS revision
171			*/
172			public String toString() {
173	ajm	1.12	return FormatName.getName(
174			_name,
175	ajm	1.13	getClass().getName(),
176	ajm	1.12	REVISION);
177	tdb	1.1	}
178
179			//---PRIVATE METHODS---
180	tdb	1.26
181			private String getInBound(String expected) throws IOException {
182			// grab the input
183			String inBound = getInBound();
184			// check if it's what we're expecting
185			if(!inBound.equals(expected)) {
186			throw new IOException("protocol error - expected:"+expected+" got:" + inBound);
187			}
188			// it should be ok then
189			return inBound;
190			}
191
192			private String getInBound() throws IOException {
193			// grab the input
194			String inBound = _socketIn.readLine();
195			// check for null's, likely disconnection
196			if(inBound == null) {
197			throw new IOException("got null from host, maybe it died");
198			}
199			// it's a valid message it seems
200			return inBound;
201			}
202	tdb	1.1
203			//---ACCESSOR/MUTATOR METHODS---
204
205			//---ATTRIBUTES---
206
207	tdb	1.11	/**
208	ajm	1.12	* This holds a reference to the
209			* system logger that is being used.
210	tdb	1.11	*/
211	ajm	1.12	private Logger _logger = ReferenceManager.getInstance().getLogger();
212	tdb	1.11
213			/**
214			* A reference to the Configuration Manager the system is using
215			*/
216	ajm	1.12	private ConfigurationManager _configManager = ReferenceManager.getInstance().getCM();
217
218			/**
219			* This is the friendly identifier of the
220			* component this class is running in.
221			* eg, a Filter may be called "filter1",
222			* If this class does not have an owning
223			* component, a name from the configuration
224			* can be placed here. This name could also
225			* be changed to null for utility classes.
226			*/
227			private String _name = FilterManager.NAME;
228
229			/**
230			* The socket this class uses
231			*/
232			private Socket _socket;
233
234			/**
235			* Used for the input stream of this socket
236			*/
237			private BufferedReader _socketIn;
238	tdb	1.11
239	ajm	1.12	/**
240			* Used for the output stream of this socket
241			*/
242			private PrintWriter _socketOut;
243	tdb	1.11
244	tdb	1.1	//---STATIC ATTRIBUTES---
245
246			}