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


/**
 * Acts as a Control Handler to a CORBA based client.
 *
 * @author  $Author: tdb $
 * @version $Id: CorbaControlHandlerServant.java,v 1.14 2001/05/29 17:02:34 tdb Exp $
 */
class CorbaControlHandlerServant extends CorbaControlHandlerPOA {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---
    
    /**
     * Construct a new CorbaControlHandlerServant.
     *
     * @param packetSorter A reference to the PacketSorter in the component
     * @param client A reference to the "servant" part of the connecting client.
     * @param queueMonitorInterval The interval at which to monitor our Queue.
     * @param clientname A name to identify the client.
     */
    public CorbaControlHandlerServant(PacketSorter packetSorter, Client client, String clientname) {
        _packetSorter = packetSorter;
        _hostList = "";
        _client = client;
        _clientname = clientname;
        _dataHandler = null;
        _logger.write(toString(), Logger.SYSINIT, "created");
    }
    
//---PUBLIC METHODS---
    
    /**
     * Start sending data to the client.
     *
     * @return a boolean stating whether the attempt to start succeeded
     */
    public boolean startData() {
        if(_dataHandler == null) {
            // create a new DataHandler
            CorbaDataHandler dh = new CorbaDataHandler(_client, this);
            // register the Queue
            _packetSorter.register(dh.getQueue(), _hostList);
            try {
                // startup a monitor on the DataHandler's queue
                ConfigurationProxy cp = ConfigurationProxy.getInstance();
                int queueMonitorInterval = Integer.parseInt(cp.getProperty("ClientInterface", "Queue.MonitorInterval"));
                String queueName = _name + " CorbaHandler:"+_clientname;
                dh.getQueue().startMonitor(queueMonitorInterval*1000, _packetSorter.getQueue(), queueName);
            } catch (PropertyNotFoundException e) {
                _logger.write(toString(), Logger.WARNING, "failed to find queue monitor config, disabling. " + e);
            }
            // start the DataHandler running
            dh.start();
            // keep a reference
            _dataHandler = dh;
            return true;
        }
        else {
            return false;
        }
    }
    
    /**
     * Stop sending data to the client.
     *
     * @return a boolean stating whether the attempt to stop succeeded
     */
    public boolean stopData() {
        if(_dataHandler != null) {
            // deregister the Queue
            _packetSorter.deregister(_dataHandler.getQueue(), _hostList);
            // stop the DataHandler
            _dataHandler.shutdown();
            // destroy the reference
            _dataHandler = null;
            return true;
        }
        else {
            return false;
        }
    }
    
    /**
     * Sets the host list for the Client to the requested semi-colon separated
     * list of hostnames. This will only succeed if we are not sending data.
     *
     * @param hostList A semi-colon separated list of hostnames to use.
     * @return Whether the request succeeded.
     */
    public boolean setHostList(String hostList) {
        if(_dataHandler == null) {
            _hostList = hostList;
            return true;
        }
        else {
            return false;
        }
    }
    
    /**
     * Disconnect, this will shutdown the data and unhook from
     * the CORBA ORB.
     */
    public void disconnect() {
        // close the data handler
        stopData();
        // disconnect from the ORB
        try {
            byte[] oid = _refman.getRootPOA().servant_to_id(this);
            _refman.getRootPOA().deactivate_object(oid);
        } catch(Exception e) {
            _logger.write(this.toString(), Logger.ERROR, "disconnect failed: "+e);
        }
    }
    
    /**
     * 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---

    /**
     * Overridden for debugging purposes
     * to see when an instance of this class
     * is destroyed
     */
    protected void finalize() throws Throwable {
        _logger.write(this.toString(), Logger.DEBUG, "finalized by GC");
    }

//---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 reference manager in use
     */
    private ReferenceManager _refman = ReferenceManager.getInstance();
    
    /**
         * A reference to the PacketSorter.
         */
    private PacketSorter _packetSorter;
    
    /**
     * The host list the Client has requested
     */
    private String _hostList;
    
    /**
     * The "servant" part of the client we're connected to.
     */
    private Client _client;
    
    /**
     * A reference to our DataHandler, if we have one
     */
    private CorbaDataHandler _dataHandler;
    
    /**
     * A name to identify the client
     */
    private String _clientname;
    
//---STATIC ATTRIBUTES---

}
Revision:	1.15
Committed:	Sat May 18 18:16:01 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.14:	+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 ;)
#	Content
1	/*
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	//---PACKAGE DECLARATION---
21	package uk.org.iscream.cms.server.clientinterface;
22
23	//---IMPORTS---
24	import uk.org.iscream.cms.server.util.*;
25	import uk.org.iscream.cms.server.componentmanager.*;
26	import uk.org.iscream.cms.server.core.*;
27	import uk.org.iscream.cms.server.client.*;
28
29
30	/**
31	* Acts as a Control Handler to a CORBA based client.
32	*
33	* @author $Author: tdb $
34	* @version $Id: CorbaControlHandlerServant.java,v 1.14 2001/05/29 17:02:34 tdb Exp $
35	*/
36	class CorbaControlHandlerServant extends CorbaControlHandlerPOA {
37
38	//---FINAL ATTRIBUTES---
39
40	/**
41	* The current CVS revision of this class
42	*/
43	public final String REVISION = "$Revision: 1.14 $";
44
45	//---STATIC METHODS---
46
47	//---CONSTRUCTORS---
48
49	/**
50	* Construct a new CorbaControlHandlerServant.
51	*
52	* @param packetSorter A reference to the PacketSorter in the component
53	* @param client A reference to the "servant" part of the connecting client.
54	* @param queueMonitorInterval The interval at which to monitor our Queue.
55	* @param clientname A name to identify the client.
56	*/
57	public CorbaControlHandlerServant(PacketSorter packetSorter, Client client, String clientname) {
58	_packetSorter = packetSorter;
59	_hostList = "";
60	_client = client;
61	_clientname = clientname;
62	_dataHandler = null;
63	_logger.write(toString(), Logger.SYSINIT, "created");
64	}
65
66	//---PUBLIC METHODS---
67
68	/**
69	* Start sending data to the client.
70	*
71	* @return a boolean stating whether the attempt to start succeeded
72	*/
73	public boolean startData() {
74	if(_dataHandler == null) {
75	// create a new DataHandler
76	CorbaDataHandler dh = new CorbaDataHandler(_client, this);
77	// register the Queue
78	_packetSorter.register(dh.getQueue(), _hostList);
79	try {
80	// startup a monitor on the DataHandler's queue
81	ConfigurationProxy cp = ConfigurationProxy.getInstance();
82	int queueMonitorInterval = Integer.parseInt(cp.getProperty("ClientInterface", "Queue.MonitorInterval"));
83	String queueName = _name + " CorbaHandler:"+_clientname;
84	dh.getQueue().startMonitor(queueMonitorInterval*1000, _packetSorter.getQueue(), queueName);
85	} catch (PropertyNotFoundException e) {
86	_logger.write(toString(), Logger.WARNING, "failed to find queue monitor config, disabling. " + e);
87	}
88	// start the DataHandler running
89	dh.start();
90	// keep a reference
91	_dataHandler = dh;
92	return true;
93	}
94	else {
95	return false;
96	}
97	}
98
99	/**
100	* Stop sending data to the client.
101	*
102	* @return a boolean stating whether the attempt to stop succeeded
103	*/
104	public boolean stopData() {
105	if(_dataHandler != null) {
106	// deregister the Queue
107	_packetSorter.deregister(_dataHandler.getQueue(), _hostList);
108	// stop the DataHandler
109	_dataHandler.shutdown();
110	// destroy the reference
111	_dataHandler = null;
112	return true;
113	}
114	else {
115	return false;
116	}
117	}
118
119	/**
120	* Sets the host list for the Client to the requested semi-colon separated
121	* list of hostnames. This will only succeed if we are not sending data.
122	*
123	* @param hostList A semi-colon separated list of hostnames to use.
124	* @return Whether the request succeeded.
125	*/
126	public boolean setHostList(String hostList) {
127	if(_dataHandler == null) {
128	_hostList = hostList;
129	return true;
130	}
131	else {
132	return false;
133	}
134	}
135
136	/**
137	* Disconnect, this will shutdown the data and unhook from
138	* the CORBA ORB.
139	*/
140	public void disconnect() {
141	// close the data handler
142	stopData();
143	// disconnect from the ORB
144	try {
145	byte[] oid = _refman.getRootPOA().servant_to_id(this);
146	_refman.getRootPOA().deactivate_object(oid);
147	} catch(Exception e) {
148	_logger.write(this.toString(), Logger.ERROR, "disconnect failed: "+e);
149	}
150	}
151
152	/**
153	* Overrides the {@link java.lang.Object#toString() Object.toString()}
154	* method to provide clean logging (every class should have this).
155	*
156	* This uses the uk.org.iscream.cms.server.util.NameFormat class
157	* to format the toString()
158	*
159	* @return the name of this class and its CVS revision
160	*/
161	public String toString() {
162	return FormatName.getName(
163	_name,
164	getClass().getName(),
165	REVISION);
166	}
167
168	//---PRIVATE METHODS---
169
170	/**
171	* Overridden for debugging purposes
172	* to see when an instance of this class
173	* is destroyed
174	*/
175	protected void finalize() throws Throwable {
176	_logger.write(this.toString(), Logger.DEBUG, "finalized by GC");
177	}
178
179	//---ACCESSOR/MUTATOR METHODS---
180
181	//---ATTRIBUTES---
182
183	/**
184	* This is the friendly identifier of the
185	* component this class is running in.
186	* eg, a Filter may be called "filter1",
187	* If this class does not have an owning
188	* component, a name from the configuration
189	* can be placed here. This name could also
190	* be changed to null for utility classes.
191	*/
192	private String _name = ClientInterfaceMain.NAME;
193
194	/**
195	* This holds a reference to the
196	* system logger that is being used.
197	*/
198	private Logger _logger = ReferenceManager.getInstance().getLogger();
199
200	/**
201	* A reference to the reference manager in use
202	*/
203	private ReferenceManager _refman = ReferenceManager.getInstance();
204
205	/**
206	* A reference to the PacketSorter.
207	*/
208	private PacketSorter _packetSorter;
209
210	/**
211	* The host list the Client has requested
212	*/
213	private String _hostList;
214
215	/**
216	* The "servant" part of the client we're connected to.
217	*/
218	private Client _client;
219
220	/**
221	* A reference to our DataHandler, if we have one
222	*/
223	private CorbaDataHandler _dataHandler;
224
225	/**
226	* A name to identify the client
227	*/
228	private String _clientname;
229
230	//---STATIC ATTRIBUTES---
231
232	}