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

/**
 * This class, a servant, listens for incoming connections from CORBA based
 * clients. Once it receives a connection it creates and assigns a CorbaControlHandler
 * object to it. The CorbaControlHandler will then handle all requests on behalf of the
 * client, and will send the client data.
 *
 * @author  $Author: tdb $
 * @version $Id: CorbaClientListenerServant.java,v 1.9 2001/05/29 17:02:34 tdb Exp $
 */
class CorbaClientListenerServant extends CorbaClientListenerPOA {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

    /**
     * Creates a new CorbaClientListenerServant.
     *
     * @param packetSorter a reference to the PacketSorter object being used
     */
    public CorbaClientListenerServant(PacketSorter packetSorter) {
        _packetSorter = packetSorter;
        _logger.write(toString(), Logger.SYSINIT, "created");
    }
    
//---PUBLIC METHODS---

    /**
     * Allows a CORBA client to connect to the server.
     *
     * @param client a reference to the "servant" part of the connecting client.
     * @param name a name to identify the client.
     * @return a CorbaControlHandler reference.
     */
    public CorbaControlHandler connect(Client client, String name) {
        CorbaControlHandlerServant cchServant = new CorbaControlHandlerServant(_packetSorter, client, name);
        org.omg.CORBA.Object objRef;
        try {
            objRef = _refman.getRootPOA().servant_to_reference(cchServant);
        } catch (Exception e) {
            objRef = null;
            _logger.write(toString(), Logger.ERROR, "Error creating CorbaControlHandler: "+e);
        }
        CorbaControlHandler corbaHandler = CorbaControlHandlerHelper.narrow(objRef);
        return corbaHandler;
    }
    
    /**
     * 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 reference manager in use
     */
    private ReferenceManager _refman = ReferenceManager.getInstance();
    
    /**
     * A reference to the PacketSorter.
     */
    private PacketSorter _packetSorter;
    
//---STATIC ATTRIBUTES---

}
Revision:	1.10
Committed:	Sat May 18 18:16:00 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.9:	+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.core.*;
25	import uk.org.iscream.cms.server.util.*;
26	import uk.org.iscream.cms.server.componentmanager.*;
27	import uk.org.iscream.cms.server.client.*;
28
29	/**
30	* This class, a servant, listens for incoming connections from CORBA based
31	* clients. Once it receives a connection it creates and assigns a CorbaControlHandler
32	* object to it. The CorbaControlHandler will then handle all requests on behalf of the
33	* client, and will send the client data.
34	*
35	* @author $Author: tdb $
36	* @version $Id: CorbaClientListenerServant.java,v 1.9 2001/05/29 17:02:34 tdb Exp $
37	*/
38	class CorbaClientListenerServant extends CorbaClientListenerPOA {
39
40	//---FINAL ATTRIBUTES---
41
42	/**
43	* The current CVS revision of this class
44	*/
45	public final String REVISION = "$Revision: 1.9 $";
46
47	//---STATIC METHODS---
48
49	//---CONSTRUCTORS---
50
51	/**
52	* Creates a new CorbaClientListenerServant.
53	*
54	* @param packetSorter a reference to the PacketSorter object being used
55	*/
56	public CorbaClientListenerServant(PacketSorter packetSorter) {
57	_packetSorter = packetSorter;
58	_logger.write(toString(), Logger.SYSINIT, "created");
59	}
60
61	//---PUBLIC METHODS---
62
63	/**
64	* Allows a CORBA client to connect to the server.
65	*
66	* @param client a reference to the "servant" part of the connecting client.
67	* @param name a name to identify the client.
68	* @return a CorbaControlHandler reference.
69	*/
70	public CorbaControlHandler connect(Client client, String name) {
71	CorbaControlHandlerServant cchServant = new CorbaControlHandlerServant(_packetSorter, client, name);
72	org.omg.CORBA.Object objRef;
73	try {
74	objRef = _refman.getRootPOA().servant_to_reference(cchServant);
75	} catch (Exception e) {
76	objRef = null;
77	_logger.write(toString(), Logger.ERROR, "Error creating CorbaControlHandler: "+e);
78	}
79	CorbaControlHandler corbaHandler = CorbaControlHandlerHelper.narrow(objRef);
80	return corbaHandler;
81	}
82
83	/**
84	* Overrides the {@link java.lang.Object#toString() Object.toString()}
85	* method to provide clean logging (every class should have this).
86	*
87	* This uses the uk.org.iscream.cms.server.util.NameFormat class
88	* to format the toString()
89	*
90	* @return the name of this class and its CVS revision
91	*/
92	public String toString() {
93	return FormatName.getName(
94	_name,
95	getClass().getName(),
96	REVISION);
97	}
98
99	//---PRIVATE METHODS---
100
101	//---ACCESSOR/MUTATOR METHODS---
102
103	//---ATTRIBUTES---
104
105	/**
106	* This is the friendly identifier of the
107	* component this class is running in.
108	* eg, a Filter may be called "filter1",
109	* If this class does not have an owning
110	* component, a name from the configuration
111	* can be placed here. This name could also
112	* be changed to null for utility classes.
113	*/
114	private String _name = ClientInterfaceMain.NAME;
115
116	/**
117	* This holds a reference to the
118	* system logger that is being used.
119	*/
120	private Logger _logger = ReferenceManager.getInstance().getLogger();
121
122	/**
123	* A reference to the reference manager in use
124	*/
125	private ReferenceManager _refman = ReferenceManager.getInstance();
126
127	/**
128	* A reference to the PacketSorter.
129	*/
130	private PacketSorter _packetSorter;
131
132	//---STATIC ATTRIBUTES---
133
134	}