server/filter/FilterServant.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.filter;

//---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.util.*;
import java.net.InetAddress;

/**
 * Passes inbound data from other Filters to a FilterThread
 *
 * @author  $Author: tdb $
 * @version $Id: FilterServant.java,v 1.20 2002/05/18 18:16:01 tdb Exp $
 */
class FilterServant extends FilterPOA {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

    /**
     * Creates a new FilterServant.
     *
     * @param queue the Queue this filter is using
     */
    public FilterServant(Queue queue) {
        _queue = queue;
        _logger.write(toString(), Logger.SYSINIT, "started");
    }
    
//---PUBLIC METHODS---

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

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

    /**
     * Our Queue object
     */
    private Queue _queue;
    
//---STATIC ATTRIBUTES---

}
Revision:	1.21
Committed:	Tue May 21 16:47:17 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.20:	+3 -2 lines
Log Message:	Added URL to GPL headers.
#	User	Rev	Content
1	tdb	1.20	/*
2			* i-scream central monitoring system
3	tdb	1.21	* http://www.i-scream.org.uk
4	tdb	1.20	* 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.18	package uk.org.iscream.cms.server.filter;
23	tdb	1.1
24			//---IMPORTS---
25	tdb	1.18	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.util.*;
29	tdb	1.4	import java.net.InetAddress;
30	tdb	1.1
31			/**
32	ajm	1.11	* Passes inbound data from other Filters to a FilterThread
33	tdb	1.1	*
34	tdb	1.19	* @author $Author: tdb $
35	tdb	1.21	* @version $Id: FilterServant.java,v 1.20 2002/05/18 18:16:01 tdb Exp $
36	tdb	1.1	*/
37			class FilterServant extends FilterPOA {
38
39			//---FINAL ATTRIBUTES---
40
41			/**
42			* The current CVS revision of this class
43			*/
44	tdb	1.21	public final String REVISION = "$Revision: 1.20 $";
45	tdb	1.1
46			//---STATIC METHODS---
47
48			//---CONSTRUCTORS---
49
50			/**
51	tdb	1.14	* Creates a new FilterServant.
52	tdb	1.1	*
53	tdb	1.14	* @param queue the Queue this filter is using
54	tdb	1.1	*/
55	tdb	1.19	public FilterServant(Queue queue) {
56	tdb	1.12	_queue = queue;
57	tdb	1.15	_logger.write(toString(), Logger.SYSINIT, "started");
58	tdb	1.1	}
59	tdb	1.9
60	tdb	1.1	//---PUBLIC METHODS---
61
62			/**
63			* Method to receive a string over corba.
64			*
65	tdb	1.14	* @param xml the String of XML to queue
66	tdb	1.1	*/
67			public void receiveXML(String xml) {
68	tdb	1.12	_queue.add(xml);
69	tdb	1.1	}
70
71			/**
72			* Overrides the {@link java.lang.Object#toString() Object.toString()}
73			* method to provide clean logging (every class should have this).
74			*
75	tdb	1.18	* This uses the uk.org.iscream.cms.server.util.NameFormat class
76	ajm	1.11	* to format the toString()
77			*
78	tdb	1.1	* @return the name of this class and its CVS revision
79			*/
80			public String toString() {
81	ajm	1.11	return FormatName.getName(
82			_name,
83			getClass().getName(),
84			REVISION);
85	tdb	1.1	}
86
87			//---PRIVATE METHODS---
88
89			//---ACCESSOR/MUTATOR METHODS---
90
91			//---ATTRIBUTES---
92
93			/**
94	ajm	1.11	* This is the friendly identifier of the
95			* component this class is running in.
96			* eg, a Filter may be called "filter1",
97			* If this class does not have an owning
98			* component, a name from the configuration
99			* can be placed here. This name could also
100			* be changed to null for utility classes.
101	tdb	1.1	*/
102	ajm	1.11	private String _name = FilterMain.NAME;
103
104	tdb	1.1	/**
105	ajm	1.11	* This holds a reference to the
106			* system logger that is being used.
107	tdb	1.1	*/
108	ajm	1.11	private Logger _logger = ReferenceManager.getInstance().getLogger();
109	tdb	1.3
110			/**
111	tdb	1.12	* Our Queue object
112	tdb	1.3	*/
113	tdb	1.12	private Queue _queue;
114	tdb	1.1
115			//---STATIC ATTRIBUTES---
116
117			}