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.server.clientinterface.*;
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.19 2002/05/21 16:47:18 tdb Exp $
 */
class RootFilterServant extends FilterPOA {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.19 $";
    
//---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.20
Committed:	Wed Feb 5 16:43:48 2003 UTC (21 years, 4 months ago) by tdb
Branch:	MAIN
Changes since 1.19:	+4 -4 lines
Log Message:	Changed the server to use the external util package. Quite a minor change, but does affect a lot of files.
#	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			import uk.org.iscream.cms.server.clientinterface.*;
29	tdb	1.20	import uk.org.iscream.cms.util.*;
30	tdb	1.1
31			/**
32	ajm	1.11	* A root filter servant has an array
33			* of client interfaces where data should be
34			* piped.
35	tdb	1.1	*
36	tdb	1.17	* @author $Author: tdb $
37	tdb	1.20	* @version $Id: RootFilterServant.java,v 1.19 2002/05/21 16:47:18 tdb Exp $
38	tdb	1.1	*/
39			class RootFilterServant extends FilterPOA {
40
41			//---FINAL ATTRIBUTES---
42
43			/**
44			* The current CVS revision of this class
45			*/
46	tdb	1.20	public final String REVISION = "$Revision: 1.19 $";
47	tdb	1.1
48			//---STATIC METHODS---
49
50			//---CONSTRUCTORS---
51
52			/**
53			* Creates a new RootFilter.
54			*
55	tdb	1.12	* @param queue a Queue to use
56	tdb	1.1	*/
57	tdb	1.12	public RootFilterServant(Queue queue) {
58			_queue = queue;
59	ajm	1.11	_logger.write(toString(), Logger.SYSINIT, "created");
60	tdb	1.1	}
61
62			//---PUBLIC METHODS---
63
64			/**
65			* Method to receive a string over corba.
66			*
67	tdb	1.12	* @param xml the String of XML to send on
68	tdb	1.1	*/
69			public void receiveXML(String xml) {
70	tdb	1.12	_queue.add(xml);
71	tdb	1.3	}
72
73	tdb	1.1	/**
74			* Overrides the {@link java.lang.Object#toString() Object.toString()}
75			* method to provide clean logging (every class should have this).
76			*
77	tdb	1.20	* This uses the uk.org.iscream.cms.util.NameFormat class
78	ajm	1.11	* to format the toString()
79			*
80	tdb	1.1	* @return the name of this class and its CVS revision
81			*/
82			public String toString() {
83	ajm	1.11	return FormatName.getName(
84			_name,
85			getClass().getName(),
86			REVISION);
87	tdb	1.1	}
88
89			//---PRIVATE METHODS---
90
91			//---ACCESSOR/MUTATOR METHODS---
92	ajm	1.11
93	tdb	1.1	//---ATTRIBUTES---
94
95			/**
96	ajm	1.11	* This is the friendly identifier of the
97			* component this class is running in.
98			* eg, a Filter may be called "filter1",
99			* If this class does not have an owning
100			* component, a name from the configuration
101			* can be placed here. This name could also
102			* be changed to null for utility classes.
103			*/
104			private String _name = RootFilter.NAME;
105
106			/**
107			* This holds a reference to the
108			* system logger that is being used.
109	tdb	1.1	*/
110	tdb	1.8	private Logger _logger = ReferenceManager.getInstance().getLogger();
111	tdb	1.1
112			/**
113	tdb	1.12	* A reference to the Queue being used.
114			*/
115			private Queue _queue;
116	tdb	1.1
117			//---STATIC ATTRIBUTES---
118
119			}