server/rootfilter/RootFilterServant.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org.uk
 * 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.rootfilter;

//---IMPORTS---
import uk.org.iscream.cms.server.core.*;
import uk.org.iscream.cms.server.componentmanager.*;
import uk.org.iscream.cms.server.filter.*;
import uk.org.iscream.cms.util.*;

/**
 * A root filter servant has an array
 * of client interfaces where data should be
 * piped.
 *
 * @author  $Author: tdb $
 * @version $Id: RootFilterServant.java,v 1.20 2003/02/05 16:43:48 tdb Exp $
 */
class RootFilterServant extends FilterPOA {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

    /**
     * Creates a new RootFilter.
     *
     * @param queue a Queue to use
     */
    public RootFilterServant(Queue queue) {
        _queue = queue;
        _logger.write(toString(), Logger.SYSINIT, "created");
    }
 
//---PUBLIC METHODS---

    /**
     * Method to receive a string over corba.
     *
     * @param xml the String of XML to send on
     */
    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 = RootFilter.NAME;

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = ReferenceManager.getInstance().getLogger();
    
    /**
     * A reference to the Queue being used.
     */
    private Queue _queue;
    
//---STATIC ATTRIBUTES---

}
Revision:	1.21
Committed:	Mon May 5 22:05:14 2003 UTC (21 years, 1 month ago) by tdb
Branch:	MAIN
Changes since 1.20:	+2 -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.
#	User	Rev	Content
1	tdb	1.18	/*
2			* i-scream central monitoring system
3	tdb	1.19	* http://www.i-scream.org.uk
4	tdb	1.18	* 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	tdb	1.1	//---PACKAGE DECLARATION---
22	tdb	1.16	package uk.org.iscream.cms.server.rootfilter;
23	tdb	1.1
24			//---IMPORTS---
25	tdb	1.16	import uk.org.iscream.cms.server.core.*;
26			import uk.org.iscream.cms.server.componentmanager.*;
27			import uk.org.iscream.cms.server.filter.*;
28	tdb	1.20	import uk.org.iscream.cms.util.*;
29	tdb	1.1
30			/**
31	ajm	1.11	* A root filter servant has an array
32			* of client interfaces where data should be
33			* piped.
34	tdb	1.1	*
35	tdb	1.17	* @author $Author: tdb $
36	tdb	1.21	* @version $Id: RootFilterServant.java,v 1.20 2003/02/05 16:43:48 tdb Exp $
37	tdb	1.1	*/
38			class RootFilterServant extends FilterPOA {
39
40			//---FINAL ATTRIBUTES---
41
42			/**
43			* The current CVS revision of this class
44			*/
45	tdb	1.21	public final String REVISION = "$Revision: 1.20 $";
46	tdb	1.1
47			//---STATIC METHODS---
48
49			//---CONSTRUCTORS---
50
51			/**
52			* Creates a new RootFilter.
53			*
54	tdb	1.12	* @param queue a Queue to use
55	tdb	1.1	*/
56	tdb	1.12	public RootFilterServant(Queue queue) {
57			_queue = queue;
58	ajm	1.11	_logger.write(toString(), Logger.SYSINIT, "created");
59	tdb	1.1	}
60
61			//---PUBLIC METHODS---
62
63			/**
64			* Method to receive a string over corba.
65			*
66	tdb	1.12	* @param xml the String of XML to send on
67	tdb	1.1	*/
68			public void receiveXML(String xml) {
69	tdb	1.12	_queue.add(xml);
70	tdb	1.3	}
71
72	tdb	1.1	/**
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.20	* This uses the uk.org.iscream.cms.util.NameFormat class
77	ajm	1.11	* to format the toString()
78			*
79	tdb	1.1	* @return the name of this class and its CVS revision
80			*/
81			public String toString() {
82	ajm	1.11	return FormatName.getName(
83			_name,
84			getClass().getName(),
85			REVISION);
86	tdb	1.1	}
87
88			//---PRIVATE METHODS---
89
90			//---ACCESSOR/MUTATOR METHODS---
91	ajm	1.11
92	tdb	1.1	//---ATTRIBUTES---
93
94			/**
95	ajm	1.11	* 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 = RootFilter.NAME;
104
105			/**
106			* This holds a reference to the
107			* system logger that is being used.
108	tdb	1.1	*/
109	tdb	1.8	private Logger _logger = ReferenceManager.getInstance().getLogger();
110	tdb	1.1
111			/**
112	tdb	1.12	* A reference to the Queue being used.
113			*/
114			private Queue _queue;
115	tdb	1.1
116			//---STATIC ATTRIBUTES---
117
118			}