server/clientinterface/ClientInterfaceMain.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.componentmanager.*;
import uk.org.iscream.cms.server.core.*;
import uk.org.iscream.cms.util.*;

/**
 * This class starts the real time clients
 * client interface.
 * This is an iscream component that sends data
 * direct to clients running on desktops to provide
 * real time information.
 *
 * @author  $Author: tdb $
 * @version $Id: ClientInterfaceMain.java,v 1.29 2003/02/05 16:43:46 tdb Exp $
 */
public class ClientInterfaceMain implements Component {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

    /**
     * Constructs a ClientInterface with the name given
     *
     * @param givenName the name
     */
    public ClientInterfaceMain(String givenName) {
        NAME = givenName;
    }

//---PUBLIC METHODS---

    /**
     * This method starts the ClientInterface
     */
    public void start() throws ComponentStartException {
        // get references to key objects
        _logger = _refman.getLogger();
        
        _logger.write(toString(), Logger.SYSINIT, "coming up");
        
        // Setup a PacketSorter
        PacketSorter ps = new PacketSorter();
        ps.start();
        
        // ClientInterfaceServant start (for inbound data)
        _logger.write(toString(), Logger.DEBUG, "starting servant for inbound data");
        try {
            ClientInterfaceServant ciServant = new ClientInterfaceServant(ps);
            //_refman.bindToOrb(ciServant, "iscream.ClientInterface\\." + ClientInterfaceMain.NAME);
            org.omg.CORBA.Object objRef = _refman.getRootPOA().servant_to_reference(ciServant);
            Client client = ClientHelper.narrow(objRef);
            
            String parent = ConfigurationProxy.getInstance().getProperty("ClientInterface." + ClientInterfaceMain.NAME, "ClientInterface.parent");
            objRef = _refman.getCORBARef("iscream.ClientInterface\\." + parent);
            CorbaClientListener listener = CorbaClientListenerHelper.narrow(objRef);
            
            CorbaControlHandler handler = listener.connect(client, NAME);
            handler.startData();
        }
        catch(Exception e) {
            // not sure what to do here
            // so we just log the error
            _logger.write(toString(), Logger.ERROR, "ERROR - " + e.getMessage());
        }
        
        // Startup the TCPListener
        TCPClientListener tcpClientListener = new TCPClientListener(ps);
        tcpClientListener.start();
        
        // Startup the CORBA Listener
        _logger.write(toString(), Logger.DEBUG, "starting servant for inbound clients");
        CorbaClientListenerServant corbaServant = new CorbaClientListenerServant(ps);
        _refman.bindToOrb(corbaServant, "iscream.ClientInterface\\." + ClientInterfaceMain.NAME);
        
        _logger.write(toString(), Logger.SYSINIT, "started");
    }
    
    /**
     * Does a dependency check. Used mainly at startup to
     * see if the required dependencies (components) are up
     * and running.
     *
     * @return a boolean value, true if the depdencies are satisfied
     */
    public boolean depCheck() {
        try {
            org.omg.CORBA.Object obj;
            obj = _refman.getCORBARef("iscream.Logger");
            obj = _refman.getCORBARef("iscream.ConfigurationManager");
            // suss out the parent client interface
            ConfigurationProxy cp = ConfigurationProxy.getInstance();
            String parentName = cp.getProperty("ClientInterface." + ClientInterfaceMain.NAME, "ClientInterface.parent");
            // check the parent is alive
            obj = _refman.getCORBARef("iscream.ClientInterface\\." + parentName);
        } catch(ComponentCORBAException e) {
            System.err.println(toString() + ": Dependency Failure: "+e);
            return false;
        } catch(PropertyNotFoundException e) {
            System.err.println(toString() + ": Unable to obtain configuration: "+e);
            return false;
        }
        // dependency check suceeded
        return true;
    }
    
    /**
     * 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---

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger;

    /**
     * A reference to the reference manager in use
     */
    private ReferenceManager _refman = ReferenceManager.getInstance();

//---STATIC ATTRIBUTES---

    /**
     * The friendly name for this component, used by
     * all related classes.
     * This is set from the configuration.
     */
    public static String NAME;

}
Revision:	1.30
Committed:	Mon May 5 22:05:06 2003 UTC (21 years ago) by tdb
Branch:	MAIN
Changes since 1.29:	+38 -20 lines
Log Message:	Tidy up of the client interface code - more commonly known as the "right hand side of the server". Right since the start the filter side of the server has been nice and tree like - every Filter sent data to another Filter. At the top of the tree there was a "special" Filter known as the RootFilter, which to the other Filters just looked like a normal Filter. This was nice, and simple, and expandable. The Client Interface on the other hand was messy. The root filter had some hacky wrapper threads which pulled from a queue and pushed to the relevant client interfaces (one for real time stuff, and the other for databases). There was no simple room for expandability - it was all hardwired to do just what was needed at the time. This commit changes that. A Client Interface now connects to another Client Interface, with a special one being found in the RootFilter (yes, maybe that needs a name change now :-). So we can chain client interfaces, and move other bits and bobs around in the server - for example, alerting no longer needs to be connected to the Client Interface, it can connect straight to the RootFilter (or, wherever the config tells it ;). Hopefully this sanitizes the underlying layout of the server a bit. As a final note, I dropped the DBInterface. This used to insert data in to a MySQL database. We've long since stopped using that, and it's fallen behind and is way out of date. For now, it's gone in to the attic.
#	User	Rev	Content
1	tdb	1.26	/*
2			* i-scream central monitoring system
3	tdb	1.27	* http://www.i-scream.org.uk
4	tdb	1.26	* 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.3	//---PACKAGE DECLARATION---
22	tdb	1.25	package uk.org.iscream.cms.server.clientinterface;
23	ajm	1.3
24			//---IMPORTS---
25	tdb	1.25	import uk.org.iscream.cms.server.componentmanager.*;
26			import uk.org.iscream.cms.server.core.*;
27	tdb	1.29	import uk.org.iscream.cms.util.*;
28	ajm	1.3
29			/**
30	ajm	1.4	* This class starts the real time clients
31			* client interface.
32			* This is an iscream component that sends data
33			* direct to clients running on desktops to provide
34			* real time information.
35	ajm	1.3	*
36	tdb	1.26	* @author $Author: tdb $
37	tdb	1.30	* @version $Id: ClientInterfaceMain.java,v 1.29 2003/02/05 16:43:46 tdb Exp $
38	ajm	1.3	*/
39	tdb	1.8	public class ClientInterfaceMain implements Component {
40	ajm	1.3
41			//---FINAL ATTRIBUTES---
42
43			/**
44			* The current CVS revision of this class
45			*/
46	tdb	1.30	public static final String REVISION = "$Revision: 1.29 $";
47	ajm	1.3
48			//---STATIC METHODS---
49
50	ajm	1.4	//---CONSTRUCTORS---
51	ajm	1.3
52	tdb	1.30	/**
53			* Constructs a ClientInterface with the name given
54			*
55			* @param givenName the name
56			*/
57			public ClientInterfaceMain(String givenName) {
58			NAME = givenName;
59			}
60
61	ajm	1.4	//---PUBLIC METHODS---
62	ajm	1.3
63	ajm	1.4	/**
64			* This method starts the ClientInterface
65			*/
66			public void start() throws ComponentStartException {
67	ajm	1.18	// get references to key objects
68	tdb	1.21	_logger = _refman.getLogger();
69	ajm	1.18
70	ajm	1.4	_logger.write(toString(), Logger.SYSINIT, "coming up");
71	tdb	1.19
72	tdb	1.11	// Setup a PacketSorter
73	tdb	1.19	PacketSorter ps = new PacketSorter();
74	tdb	1.12	ps.start();
75	tdb	1.10
76	ajm	1.3	// ClientInterfaceServant start (for inbound data)
77	ajm	1.4	_logger.write(toString(), Logger.DEBUG, "starting servant for inbound data");
78	tdb	1.30	try {
79			ClientInterfaceServant ciServant = new ClientInterfaceServant(ps);
80			//_refman.bindToOrb(ciServant, "iscream.ClientInterface\\." + ClientInterfaceMain.NAME);
81			org.omg.CORBA.Object objRef = _refman.getRootPOA().servant_to_reference(ciServant);
82			Client client = ClientHelper.narrow(objRef);
83
84			String parent = ConfigurationProxy.getInstance().getProperty("ClientInterface." + ClientInterfaceMain.NAME, "ClientInterface.parent");
85			objRef = _refman.getCORBARef("iscream.ClientInterface\\." + parent);
86			CorbaClientListener listener = CorbaClientListenerHelper.narrow(objRef);
87
88			CorbaControlHandler handler = listener.connect(client, NAME);
89			handler.startData();
90			}
91			catch(Exception e) {
92			// not sure what to do here
93			// so we just log the error
94			_logger.write(toString(), Logger.ERROR, "ERROR - " + e.getMessage());
95			}
96	ajm	1.3
97	tdb	1.13	// Startup the TCPListener
98	tdb	1.19	TCPClientListener tcpClientListener = new TCPClientListener(ps);
99	tdb	1.9	tcpClientListener.start();
100	tdb	1.16
101			// Startup the CORBA Listener
102			_logger.write(toString(), Logger.DEBUG, "starting servant for inbound clients");
103	tdb	1.19	CorbaClientListenerServant corbaServant = new CorbaClientListenerServant(ps);
104	tdb	1.30	_refman.bindToOrb(corbaServant, "iscream.ClientInterface\\." + ClientInterfaceMain.NAME);
105	ajm	1.3
106	ajm	1.4	_logger.write(toString(), Logger.SYSINIT, "started");
107	ajm	1.3	}
108	tdb	1.20
109			/**
110			* Does a dependency check. Used mainly at startup to
111			* see if the required dependencies (components) are up
112			* and running.
113			*
114			* @return a boolean value, true if the depdencies are satisfied
115			*/
116			public boolean depCheck() {
117			try {
118			org.omg.CORBA.Object obj;
119			obj = _refman.getCORBARef("iscream.Logger");
120			obj = _refman.getCORBARef("iscream.ConfigurationManager");
121	tdb	1.30	// suss out the parent client interface
122			ConfigurationProxy cp = ConfigurationProxy.getInstance();
123			String parentName = cp.getProperty("ClientInterface." + ClientInterfaceMain.NAME, "ClientInterface.parent");
124			// check the parent is alive
125			obj = _refman.getCORBARef("iscream.ClientInterface\\." + parentName);
126	tdb	1.20	} catch(ComponentCORBAException e) {
127	tdb	1.22	System.err.println(toString() + ": Dependency Failure: "+e);
128	tdb	1.30	return false;
129			} catch(PropertyNotFoundException e) {
130			System.err.println(toString() + ": Unable to obtain configuration: "+e);
131	tdb	1.20	return false;
132			}
133			// dependency check suceeded
134			return true;
135			}
136
137	ajm	1.4	/**
138			* Overrides the {@link java.lang.Object#toString() Object.toString()}
139			* method to provide clean logging (every class should have this).
140			*
141	tdb	1.29	* This uses the uk.org.iscream.cms.util.NameFormat class
142	ajm	1.4	* to format the toString()
143			*
144			* @return the name of this class and its CVS revision
145			*/
146			public String toString() {
147			return FormatName.getName(
148	ajm	1.5	NAME,
149	ajm	1.4	getClass().getName(),
150			REVISION);
151			}
152	ajm	1.3
153			//---PRIVATE METHODS---
154
155			//---ACCESSOR/MUTATOR METHODS---
156
157			//---ATTRIBUTES---
158	ajm	1.4
159			/**
160			* This holds a reference to the
161			* system logger that is being used.
162			*/
163	ajm	1.18	private Logger _logger;
164	ajm	1.4
165			/**
166			* A reference to the reference manager in use
167			*/
168	tdb	1.21	private ReferenceManager _refman = ReferenceManager.getInstance();
169	ajm	1.4
170	ajm	1.3	//---STATIC ATTRIBUTES---
171
172	ajm	1.4	/**
173			* The friendly name for this component, used by
174			* all related classes.
175			* This is set from the configuration.
176			*/
177			public static String NAME;
178
179			}