ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/cms/source/server/uk/org/iscream/cms/server/clientinterface/ClientInterfaceServant.java
Revision: 1.15
Committed: Mon May 5 22:05:06 2003 UTC (21 years ago) by tdb
Branch: MAIN
Changes since 1.14: +3 -3 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.

File Contents

# Content
1 /*
2 * i-scream central monitoring system
3 * http://www.i-scream.org.uk
4 * 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 //---PACKAGE DECLARATION---
22 package uk.org.iscream.cms.server.clientinterface;
23
24 //---IMPORTS---
25 import uk.org.iscream.cms.server.core.*;
26 import uk.org.iscream.cms.util.*;
27 import uk.org.iscream.cms.server.componentmanager.*;
28
29 /**
30 * 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 *
35 * @author $Author: tdb $
36 * @version $Id: ClientInterfaceServant.java,v 1.14 2003/02/05 16:43:46 tdb Exp $
37 */
38 class ClientInterfaceServant extends ClientPOA {
39
40 //---FINAL ATTRIBUTES---
41
42 /**
43 * The current CVS revision of this class
44 */
45 public final String REVISION = "$Revision: 1.14 $";
46
47 //---STATIC METHODS---
48
49 //---CONSTRUCTORS---
50
51 /**
52 * Creates a new ClientInterfaceServant.
53 *
54 * @param packetSorter a reference to the PacketSorter object being used
55 */
56 public ClientInterfaceServant(PacketSorter packetSorter) {
57 _queue = packetSorter.getQueue();
58 _logger.write(toString(), Logger.SYSINIT, "created");
59 }
60
61 //---PUBLIC METHODS---
62
63 /**
64 * Method to receive a string over CORBA.
65 *
66 * @param xml the XML string to be queued for processing.
67 */
68 public void receiveXML(String xml) {
69 _queue.add(xml);
70 }
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 * This uses the uk.org.iscream.cms.util.NameFormat class
77 * 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 /**
112 * A reference to the Queue we'll add data to. This is
113 * actually located in the PacketSorter.
114 */
115 private Queue _queue;
116
117 //---STATIC ATTRIBUTES---
118
119 }