server/clientinterface/ClientInterfaceServant.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org
 * 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.util.*;
import uk.org.iscream.cms.server.componentmanager.*;

/**
 * This class, a servant, listens for incoming data sent to it
 * using CORBA. This data is then queued in the PacketSorter.
 * It does no processing of the data, and is only a seperate
 * class to keep the CORBA stuff out of the PacketSorter.
 *
 * @author  $Author: tdb $
 * @version $Id: ClientInterfaceServant.java,v 1.15 2003/05/05 22:05:06 tdb Exp $
 */
class ClientInterfaceServant extends ClientPOA {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

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

    /**
     * Method to receive a string over CORBA.
     *
     * @param xml the XML string to be queued for processing.
     */
    public void receiveXML(String xml) {
        _queue.add(xml);
    }
    
    /**
     * 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 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 Queue we'll add data to. This is
     * actually located in the PacketSorter.
     */
    private Queue _queue;
    
//---STATIC ATTRIBUTES---

}
Revision:	1.16
Committed:	Sun Aug 1 10:40:48 2004 UTC (19 years, 9 months ago) by tdb
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.15:	+3 -3 lines
Log Message:	Catch a lot of old URL's and update them. Also remove a couple of old files that aren't used.
#	User	Rev	Content
1	tdb	1.12	/*
2			* i-scream central monitoring system
3	tdb	1.16	* http://www.i-scream.org
4	tdb	1.12	* 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.11	package uk.org.iscream.cms.server.clientinterface;
23	ajm	1.3
24			//---IMPORTS---
25	tdb	1.11	import uk.org.iscream.cms.server.core.*;
26	tdb	1.14	import uk.org.iscream.cms.util.*;
27	tdb	1.11	import uk.org.iscream.cms.server.componentmanager.*;
28	ajm	1.3
29			/**
30	tdb	1.9	* This class, a servant, listens for incoming data sent to it
31			* using CORBA. This data is then queued in the PacketSorter.
32			* It does no processing of the data, and is only a seperate
33			* class to keep the CORBA stuff out of the PacketSorter.
34	ajm	1.3	*
35	tdb	1.12	* @author $Author: tdb $
36	tdb	1.16	* @version $Id: ClientInterfaceServant.java,v 1.15 2003/05/05 22:05:06 tdb Exp $
37	ajm	1.3	*/
38	tdb	1.15	class ClientInterfaceServant extends ClientPOA {
39	ajm	1.3
40			//---FINAL ATTRIBUTES---
41
42			/**
43			* The current CVS revision of this class
44			*/
45	tdb	1.16	public final String REVISION = "$Revision: 1.15 $";
46	ajm	1.3
47			//---STATIC METHODS---
48
49			//---CONSTRUCTORS---
50
51			/**
52			* Creates a new ClientInterfaceServant.
53	tdb	1.9	*
54			* @param packetSorter a reference to the PacketSorter object being used
55	ajm	1.3	*/
56	tdb	1.9	public ClientInterfaceServant(PacketSorter packetSorter) {
57			_queue = packetSorter.getQueue();
58	ajm	1.3	_logger.write(toString(), Logger.SYSINIT, "created");
59			}
60
61			//---PUBLIC METHODS---
62
63			/**
64	tdb	1.9	* Method to receive a string over CORBA.
65	ajm	1.3	*
66	tdb	1.9	* @param xml the XML string to be queued for processing.
67	ajm	1.3	*/
68			public void receiveXML(String xml) {
69	tdb	1.7	_queue.add(xml);
70	ajm	1.3	}
71
72			/**
73			* Overrides the {@link java.lang.Object#toString() Object.toString()}
74			* method to provide clean logging (every class should have this).
75			*
76	tdb	1.14	* This uses the uk.org.iscream.cms.util.NameFormat class
77	ajm	1.3	* to format the toString()
78			*
79			* @return the name of this class and its CVS revision
80			*/
81			public String toString() {
82			return FormatName.getName(
83			_name,
84			getClass().getName(),
85			REVISION);
86			}
87
88			//---PRIVATE METHODS---
89
90			//---ACCESSOR/MUTATOR METHODS---
91
92			//---ATTRIBUTES---
93
94			/**
95			* This is the friendly identifier of the
96			* component this class is running in.
97			* eg, a Filter may be called "filter1",
98			* If this class does not have an owning
99			* component, a name from the configuration
100			* can be placed here. This name could also
101			* be changed to null for utility classes.
102			*/
103			private String _name = ClientInterfaceMain.NAME;
104
105			/**
106			* This holds a reference to the
107			* system logger that is being used.
108			*/
109			private Logger _logger = ReferenceManager.getInstance().getLogger();
110
111	tdb	1.9	/**
112			* A reference to the Queue we'll add data to. This is
113			* actually located in the PacketSorter.
114			*/
115	tdb	1.7	private Queue _queue;
116	ajm	1.3
117			//---STATIC ATTRIBUTES---
118
119			}