server/clientinterface/TCPClientListener.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org.uk
 * 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.clientinterface;

//---IMPORTS---
import uk.org.iscream.cms.server.util.*;
import uk.org.iscream.cms.server.core.*;
import uk.org.iscream.cms.server.componentmanager.*;
import java.io.IOException;
import java.net.Socket;
import java.net.ServerSocket;
import java.net.InetAddress;
import java.net.UnknownHostException;

/**
 * Listener for incoming TCP clients, and startup a Handler
 * a connection is received.
 *
 * @author  $Author: tdb $
 * @version $Id: TCPClientListener.java,v 1.16 2002/05/18 18:16:01 tdb Exp $
 */
class TCPClientListener extends Thread {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.16 $";
    
    public static final int DEFPORT = 4510;
    
//---STATIC METHODS---

//---CONSTRUCTORS---

        /**
     * Constructs a new TCPClientListener
     *
         * @param packetSorter A reference to the PacketSorter
         */
    public TCPClientListener(PacketSorter packetSorter) {
        // set the Thread name
        setName("clientinterface.TCPClientListener");
        
        _packetSorter = packetSorter;
        _logger.write(toString(), Logger.SYSINIT, "started");
    }

//---PUBLIC METHODS---

        /**
         * The run() method is the main loop for this thread, and we
         * will remain in here until such a point as something goes
         * wrong with the listening. After initially setting up the
         * ServerSocket we go round a while loop receiving connections
         * and then passing them off to handler processes to deal with.
         */
    public void run(){
        // setup an empty ACL defaulting to ALLOW
        ACL acl = new ACL(ACL.ALLOW);
        
        // get our port
        int portNum;
        try {
            String port = ConfigurationProxy.getInstance().getProperty("ClientInterface", "ClientInterface.listenPort");
            portNum = Integer.parseInt(port);
        } catch (PropertyNotFoundException e) {
            portNum = DEFPORT;
            _logger.write(toString(), Logger.WARNING, "Configuration not found, using default of "+portNum+" : "+e);
        } catch (NumberFormatException e) {
            portNum = DEFPORT;
            _logger.write(toString(), Logger.WARNING, "Bad configuration found, using default of "+portNum+" : "+e);
        }
        
        ServerSocket listenPort=null;
                // We use this boolean so we can break out of the while loop if we want
        boolean run = true;
        try{
                        // Setup the ServerSocket so that clients can connect
                        listenPort = new ACLServerSocket(acl, portNum);
        }
        catch(IOException e){
        }
                // Log what machine/port we're listening on
                try{
                        _logger.write(toString(), Logger.SYSMSG, "ClientListener listening on "
                                                                                +InetAddress.getLocalHost().getHostName()
                                                                                +"/"+InetAddress.getLocalHost().getHostAddress()
                                                                                +" port "+listenPort.getLocalPort());
                }
                catch(UnknownHostException e){
                        _logger.write(toString(), Logger.SYSMSG, "ClientListener listening on UnknownHost "
                                                                                +"port "+listenPort.getLocalPort());
                }
                // Loop round constantly until we decide to stop
                ConfigurationProxy cp = ConfigurationProxy.getInstance();
        String stringACL = "";
        String newStringACL = "";
        while(run){
            // get hold of the ACL in the configuration
            try {
                newStringACL = cp.getProperty("ClientInterface", "ClientInterface.TCPControlChannelACL");
            }
            catch(PropertyNotFoundException e) {
                // if we can't find it, we'll just use a null ACL
                newStringACL = "";
                _logger.write(toString(), Logger.WARNING, "No ACL found for ClientInterface (control channel listener), using empty ACL instead: " + e);
            }
            // check to see if the ACL has changed
            if(!newStringACL.equals(stringACL)) {
                _logger.write(toString(), Logger.SYSMSG, "Reloading Access Control List");
                // clear the ACL
                acl.clear();
                // set the default to something sane
                acl.setDefaultMode(ACL.ALLOW);
                // add the new ACL (this may change the default)
                acl.add(newStringACL);
                stringACL = newStringACL;
            }
            Socket hostSocket=null;
            try{
                _logger.write(toString(), Logger.SYSMSG, "Waiting for Connection");
                                // This will block until a host connects - at which point we get a Socket
                hostSocket = listenPort.accept();
                _logger.write(toString(), Logger.SYSMSG, "Connection accepted from: " + hostSocket.toString());
            }
            catch(IOException e){
                                // Something went wrong with the ServerSocket, so we'll stop listening
                run=false;
            }
                        // If we've stopped on the line above we won't want to try this !
            if(run){
                                try {
                                    // start up a ControlHandler to chat to the new Client
                                    TCPControlHandler ctl = new TCPControlHandler(hostSocket, _packetSorter);
                                    ctl.start();
                } catch (IOException e) {
                    _logger.write(toString(), Logger.ERROR, e.toString());
                }
            }
        }
                // Best log the fact that we're stopping
        _logger.write(toString(), Logger.FATAL, "Fatal error, shutdown pending");
    }

    /**
     * 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---

    /**
     * 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 = ClientInterfaceMain.NAME;

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = ReferenceManager.getInstance().getLogger();
    
    /**
         * A reference to the PacketSorter.
         */
    private PacketSorter _packetSorter;
    
//---STATIC ATTRIBUTES---

}
Revision:	1.17
Committed:	Tue May 21 16:47:16 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.16:	+3 -2 lines
Log Message:	Added URL to GPL headers.
#	User	Rev	Content
1	tdb	1.16	/*
2			* i-scream central monitoring system
3	tdb	1.17	* http://www.i-scream.org.uk
4	tdb	1.16	* 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	ajm	1.2	//---PACKAGE DECLARATION---
22	tdb	1.13	package uk.org.iscream.cms.server.clientinterface;
23	ajm	1.2
24			//---IMPORTS---
25	tdb	1.13	import uk.org.iscream.cms.server.util.*;
26			import uk.org.iscream.cms.server.core.*;
27			import uk.org.iscream.cms.server.componentmanager.*;
28	ajm	1.2	import java.io.IOException;
29			import java.net.Socket;
30			import java.net.ServerSocket;
31			import java.net.InetAddress;
32			import java.net.UnknownHostException;
33
34			/**
35	tdb	1.8	* Listener for incoming TCP clients, and startup a Handler
36			* a connection is received.
37	ajm	1.2	*
38	tdb	1.14	* @author $Author: tdb $
39	tdb	1.17	* @version $Id: TCPClientListener.java,v 1.16 2002/05/18 18:16:01 tdb Exp $
40	ajm	1.2	*/
41	tdb	1.5	class TCPClientListener extends Thread {
42	ajm	1.2
43			//---FINAL ATTRIBUTES---
44
45			/**
46			* The current CVS revision of this class
47			*/
48	tdb	1.17	public final String REVISION = "$Revision: 1.16 $";
49	tdb	1.11
50			public static final int DEFPORT = 4510;
51	ajm	1.2
52			//---STATIC METHODS---
53
54			//---CONSTRUCTORS---
55
56			/**
57	tdb	1.5	* Constructs a new TCPClientListener
58	ajm	1.2	*
59	tdb	1.11	* @param packetSorter A reference to the PacketSorter
60	ajm	1.2	*/
61	tdb	1.11	public TCPClientListener(PacketSorter packetSorter) {
62	tdb	1.10	// set the Thread name
63			setName("clientinterface.TCPClientListener");
64
65	tdb	1.8	_packetSorter = packetSorter;
66	ajm	1.2	_logger.write(toString(), Logger.SYSINIT, "started");
67			}
68
69			//---PUBLIC METHODS---
70
71			/**
72			* The run() method is the main loop for this thread, and we
73			* will remain in here until such a point as something goes
74			* wrong with the listening. After initially setting up the
75			* ServerSocket we go round a while loop receiving connections
76	tdb	1.8	* and then passing them off to handler processes to deal with.
77	ajm	1.2	*/
78			public void run(){
79	tdb	1.15	// setup an empty ACL defaulting to ALLOW
80			ACL acl = new ACL(ACL.ALLOW);
81	tdb	1.14
82	tdb	1.11	// get our port
83			int portNum;
84			try {
85			String port = ConfigurationProxy.getInstance().getProperty("ClientInterface", "ClientInterface.listenPort");
86			portNum = Integer.parseInt(port);
87			} catch (PropertyNotFoundException e) {
88			portNum = DEFPORT;
89			_logger.write(toString(), Logger.WARNING, "Configuration not found, using default of "+portNum+" : "+e);
90			} catch (NumberFormatException e) {
91			portNum = DEFPORT;
92			_logger.write(toString(), Logger.WARNING, "Bad configuration found, using default of "+portNum+" : "+e);
93			}
94
95	ajm	1.2	ServerSocket listenPort=null;
96			// We use this boolean so we can break out of the while loop if we want
97			boolean run = true;
98			try{
99			// Setup the ServerSocket so that clients can connect
100	tdb	1.15	listenPort = new ACLServerSocket(acl, portNum);
101	ajm	1.2	}
102			catch(IOException e){
103			}
104			// Log what machine/port we're listening on
105			try{
106			_logger.write(toString(), Logger.SYSMSG, "ClientListener listening on "
107			+InetAddress.getLocalHost().getHostName()
108			+"/"+InetAddress.getLocalHost().getHostAddress()
109			+" port "+listenPort.getLocalPort());
110			}
111			catch(UnknownHostException e){
112			_logger.write(toString(), Logger.SYSMSG, "ClientListener listening on UnknownHost "
113			+"port "+listenPort.getLocalPort());
114			}
115			// Loop round constantly until we decide to stop
116	tdb	1.15	ConfigurationProxy cp = ConfigurationProxy.getInstance();
117			String stringACL = "";
118			String newStringACL = "";
119	ajm	1.2	while(run){
120	tdb	1.15	// get hold of the ACL in the configuration
121			try {
122			newStringACL = cp.getProperty("ClientInterface", "ClientInterface.TCPControlChannelACL");
123			}
124			catch(PropertyNotFoundException e) {
125			// if we can't find it, we'll just use a null ACL
126			newStringACL = "";
127			_logger.write(toString(), Logger.WARNING, "No ACL found for ClientInterface (control channel listener), using empty ACL instead: " + e);
128			}
129			// check to see if the ACL has changed
130			if(!newStringACL.equals(stringACL)) {
131			_logger.write(toString(), Logger.SYSMSG, "Reloading Access Control List");
132			// clear the ACL
133			acl.clear();
134			// set the default to something sane
135			acl.setDefaultMode(ACL.ALLOW);
136			// add the new ACL (this may change the default)
137			acl.add(newStringACL);
138			stringACL = newStringACL;
139			}
140	ajm	1.2	Socket hostSocket=null;
141			try{
142			_logger.write(toString(), Logger.SYSMSG, "Waiting for Connection");
143			// This will block until a host connects - at which point we get a Socket
144			hostSocket = listenPort.accept();
145			_logger.write(toString(), Logger.SYSMSG, "Connection accepted from: " + hostSocket.toString());
146			}
147			catch(IOException e){
148			// Something went wrong with the ServerSocket, so we'll stop listening
149			run=false;
150			}
151			// If we've stopped on the line above we won't want to try this !
152			if(run){
153			try {
154	tdb	1.8	// start up a ControlHandler to chat to the new Client
155	tdb	1.11	TCPControlHandler ctl = new TCPControlHandler(hostSocket, _packetSorter);
156	tdb	1.4	ctl.start();
157	ajm	1.2	} catch (IOException e) {
158			_logger.write(toString(), Logger.ERROR, e.toString());
159			}
160			}
161			}
162			// Best log the fact that we're stopping
163			_logger.write(toString(), Logger.FATAL, "Fatal error, shutdown pending");
164			}
165
166			/**
167			* Overrides the {@link java.lang.Object#toString() Object.toString()}
168			* method to provide clean logging (every class should have this).
169			*
170	tdb	1.13	* This uses the uk.org.iscream.cms.server.util.NameFormat class
171	ajm	1.2	* to format the toString()
172			*
173			* @return the name of this class and its CVS revision
174			*/
175			public String toString() {
176			return FormatName.getName(
177			_name,
178			getClass().getName(),
179			REVISION);
180			}
181
182			//---PRIVATE METHODS---
183
184			//---ACCESSOR/MUTATOR METHODS---
185
186			//---ATTRIBUTES---
187
188			/**
189			* This is the friendly identifier of the
190			* component this class is running in.
191			* eg, a Filter may be called "filter1",
192			* If this class does not have an owning
193			* component, a name from the configuration
194			* can be placed here. This name could also
195			* be changed to null for utility classes.
196			*/
197			private String _name = ClientInterfaceMain.NAME;
198
199			/**
200			* This holds a reference to the
201			* system logger that is being used.
202			*/
203			private Logger _logger = ReferenceManager.getInstance().getLogger();
204
205			/**
206	tdb	1.7	* A reference to the PacketSorter.
207	ajm	1.2	*/
208	tdb	1.8	private PacketSorter _packetSorter;
209	tdb	1.9
210	ajm	1.2	//---STATIC ATTRIBUTES---
211
212			}