server/clientinterface/ClientInterfaceMain.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.clientinterface;

//---IMPORTS---
import uk.org.iscream.cms.server.componentmanager.*;
import uk.org.iscream.cms.server.core.*;
import uk.org.iscream.cms.server.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.25 2001/05/29 17:02:34 tdb Exp $
 */
public class ClientInterfaceMain implements Component {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

//---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");
        
        
        ConfigurationProxy cp = ConfigurationProxy.getInstance();
        String configName = "ClientInterface";
        
        // set our name
        try {
            NAME = cp.getProperty(configName, "ClientInterface.name");
        } catch (PropertyNotFoundException e) {
            NAME = null;
            _logger.write(toString(), Logger.WARNING, "ClientInterface name not set: "+e);
        }
        
        _logger.write(toString(), Logger.SYSINIT, "configured");
        
        // Setup a PacketSorter
        PacketSorter ps = new PacketSorter();
        ps.start();
        
        // ClientInterfaceServant start (for inbound data)
        _logger.write(toString(), Logger.DEBUG, "starting servant for inbound data");
        ClientInterfaceServant ciServant = new ClientInterfaceServant(ps);
        _refman.bindToOrb(ciServant, "iscream.ClientInterface." + ClientInterfaceMain.NAME);
        
        // 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);
        // !!! verify this name is correct at some point !!!
        _refman.bindToOrb(corbaServant, "iscream.ClientInterface.CorbaListener");
        
        _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");
        } catch(ComponentCORBAException e) {
            System.err.println(toString() + ": Dependency Failure: "+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.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 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.26
Committed:	Sat May 18 18:16:00 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.25:	+22 -3 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.26	/*
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	ajm	1.3	//---PACKAGE DECLARATION---
21	tdb	1.25	package uk.org.iscream.cms.server.clientinterface;
22	ajm	1.3
23			//---IMPORTS---
24	tdb	1.25	import uk.org.iscream.cms.server.componentmanager.*;
25			import uk.org.iscream.cms.server.core.*;
26			import uk.org.iscream.cms.server.util.*;
27	ajm	1.3
28			/**
29	ajm	1.4	* This class starts the real time clients
30			* client interface.
31			* This is an iscream component that sends data
32			* direct to clients running on desktops to provide
33			* real time information.
34	ajm	1.3	*
35	tdb	1.26	* @author $Author: tdb $
36			* @version $Id: ClientInterfaceMain.java,v 1.25 2001/05/29 17:02:34 tdb Exp $
37	ajm	1.3	*/
38	tdb	1.8	public class ClientInterfaceMain implements Component {
39	ajm	1.3
40			//---FINAL ATTRIBUTES---
41
42			/**
43			* The current CVS revision of this class
44			*/
45	tdb	1.26	public static final String REVISION = "$Revision: 1.25 $";
46	ajm	1.3
47			//---STATIC METHODS---
48
49	ajm	1.4	//---CONSTRUCTORS---
50	ajm	1.3
51	ajm	1.4	//---PUBLIC METHODS---
52	ajm	1.3
53	ajm	1.4	/**
54			* This method starts the ClientInterface
55			*/
56			public void start() throws ComponentStartException {
57	ajm	1.18	// get references to key objects
58	tdb	1.21	_logger = _refman.getLogger();
59	ajm	1.18
60	ajm	1.4	_logger.write(toString(), Logger.SYSINIT, "coming up");
61	tdb	1.19
62
63			ConfigurationProxy cp = ConfigurationProxy.getInstance();
64			String configName = "ClientInterface";
65
66			// set our name
67			try {
68	tdb	1.24	NAME = cp.getProperty(configName, "ClientInterface.name");
69	tdb	1.19	} catch (PropertyNotFoundException e) {
70			NAME = null;
71			_logger.write(toString(), Logger.WARNING, "ClientInterface name not set: "+e);
72	tdb	1.14	}
73	ajm	1.4
74			_logger.write(toString(), Logger.SYSINIT, "configured");
75	tdb	1.10
76	tdb	1.11	// Setup a PacketSorter
77	tdb	1.19	PacketSorter ps = new PacketSorter();
78	tdb	1.12	ps.start();
79	tdb	1.10
80	ajm	1.3	// ClientInterfaceServant start (for inbound data)
81	ajm	1.4	_logger.write(toString(), Logger.DEBUG, "starting servant for inbound data");
82	tdb	1.11	ClientInterfaceServant ciServant = new ClientInterfaceServant(ps);
83	ajm	1.4	_refman.bindToOrb(ciServant, "iscream.ClientInterface." + ClientInterfaceMain.NAME);
84	ajm	1.3
85	tdb	1.13	// Startup the TCPListener
86	tdb	1.19	TCPClientListener tcpClientListener = new TCPClientListener(ps);
87	tdb	1.9	tcpClientListener.start();
88	tdb	1.16
89			// Startup the CORBA Listener
90			_logger.write(toString(), Logger.DEBUG, "starting servant for inbound clients");
91	tdb	1.19	CorbaClientListenerServant corbaServant = new CorbaClientListenerServant(ps);
92	tdb	1.16	// !!! verify this name is correct at some point !!!
93			_refman.bindToOrb(corbaServant, "iscream.ClientInterface.CorbaListener");
94	ajm	1.3
95	ajm	1.4	_logger.write(toString(), Logger.SYSINIT, "started");
96	ajm	1.3	}
97	tdb	1.20
98			/**
99			* Does a dependency check. Used mainly at startup to
100			* see if the required dependencies (components) are up
101			* and running.
102			*
103			* @return a boolean value, true if the depdencies are satisfied
104			*/
105			public boolean depCheck() {
106			try {
107			org.omg.CORBA.Object obj;
108			obj = _refman.getCORBARef("iscream.Logger");
109			obj = _refman.getCORBARef("iscream.ConfigurationManager");
110			} catch(ComponentCORBAException e) {
111	tdb	1.22	System.err.println(toString() + ": Dependency Failure: "+e);
112	tdb	1.20	return false;
113			}
114			// dependency check suceeded
115			return true;
116			}
117
118	ajm	1.4	/**
119			* Overrides the {@link java.lang.Object#toString() Object.toString()}
120			* method to provide clean logging (every class should have this).
121			*
122	tdb	1.25	* This uses the uk.org.iscream.cms.server.util.NameFormat class
123	ajm	1.4	* to format the toString()
124			*
125			* @return the name of this class and its CVS revision
126			*/
127			public String toString() {
128			return FormatName.getName(
129	ajm	1.5	NAME,
130	ajm	1.4	getClass().getName(),
131			REVISION);
132			}
133	ajm	1.3
134			//---PRIVATE METHODS---
135
136			//---ACCESSOR/MUTATOR METHODS---
137
138			//---ATTRIBUTES---
139	ajm	1.4
140			/**
141			* This holds a reference to the
142			* system logger that is being used.
143			*/
144	ajm	1.18	private Logger _logger;
145	ajm	1.4
146			/**
147			* A reference to the reference manager in use
148			*/
149	tdb	1.21	private ReferenceManager _refman = ReferenceManager.getInstance();
150	ajm	1.4
151	ajm	1.3	//---STATIC ATTRIBUTES---
152
153	ajm	1.4	/**
154			* The friendly name for this component, used by
155			* all related classes.
156			* This is set from the configuration.
157			*/
158			public static String NAME;
159
160			}