server/rootfilter/RootFilterServant.java

//---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.server.util.*;

/**
 * A root filter servant has an array
 * of client interfaces where data should be
 * piped.
 *
 * @author  $Author: tdb1 $
 * @version $Id: RootFilterServant.java,v 1.15 2001/03/14 23:25:29 tdb1 Exp $
 */
class RootFilterServant extends FilterPOA {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.15 $";
    
//---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.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---

    /**
     * This method is provided because the RootFilter appears
     * as another Filter to the rest of the Filter tree. This
     * method is required by the interface, although it actually
     * returns null.
     *
     * @return null
     */
    public String getUDPPort() {
        return null;
    }
    
    /**
     * This method is provided because the RootFilter appears
     * as another Filter to the rest of the Filter tree. This
     * method is required by the interface, although it actually
     * returns null.
     *
     * @return null
     */
    public String getTCPPort() {
        return null;
    }
    
    /**
     * This method is provided because the RootFilter appears
     * as another Filter to the rest of the Filter tree. This
     * method is required by the interface, although it actually
     * returns null.
     *
     * @return null
     */
    public String getHostName() {
        return null;
    }

//---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.16
Committed:	Tue May 29 17:02:35 2001 UTC (23 years ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PIRCBOT
Changes since 1.15:	+9 -9 lines
Log Message:	Major change in the java package naming. This has been held off for some time now, but it really needed doing. The future packaging of all i-scream products will be; uk.org.iscream.<product>.<subpart>.* In the case of the central monitoring system server this will be; uk.org.iscream.cms.server.* The whole server has been changed to follow this structure, and tested to a smallish extent. Further changes in other parts of the CMS will follow.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.org.iscream.cms.server.rootfilter;
3
4	//---IMPORTS---
5	import uk.org.iscream.cms.server.core.*;
6	import uk.org.iscream.cms.server.componentmanager.*;
7	import uk.org.iscream.cms.server.filter.*;
8	import uk.org.iscream.cms.server.clientinterface.*;
9	import uk.org.iscream.cms.server.util.*;
10
11	/**
12	* A root filter servant has an array
13	* of client interfaces where data should be
14	* piped.
15	*
16	* @author $Author: tdb1 $
17	* @version $Id: RootFilterServant.java,v 1.15 2001/03/14 23:25:29 tdb1 Exp $
18	*/
19	class RootFilterServant extends FilterPOA {
20
21	//---FINAL ATTRIBUTES---
22
23	/**
24	* The current CVS revision of this class
25	*/
26	public final String REVISION = "$Revision: 1.15 $";
27
28	//---STATIC METHODS---
29
30	//---CONSTRUCTORS---
31
32	/**
33	* Creates a new RootFilter.
34	*
35	* @param queue a Queue to use
36	*/
37	public RootFilterServant(Queue queue) {
38	_queue = queue;
39	_logger.write(toString(), Logger.SYSINIT, "created");
40	}
41
42	//---PUBLIC METHODS---
43
44	/**
45	* Method to receive a string over corba.
46	*
47	* @param xml the String of XML to send on
48	*/
49	public void receiveXML(String xml) {
50	_queue.add(xml);
51	}
52
53	/**
54	* Overrides the {@link java.lang.Object#toString() Object.toString()}
55	* method to provide clean logging (every class should have this).
56	*
57	* This uses the uk.org.iscream.cms.server.util.NameFormat class
58	* to format the toString()
59	*
60	* @return the name of this class and its CVS revision
61	*/
62	public String toString() {
63	return FormatName.getName(
64	_name,
65	getClass().getName(),
66	REVISION);
67	}
68
69	//---PRIVATE METHODS---
70
71	//---ACCESSOR/MUTATOR METHODS---
72
73	/**
74	* This method is provided because the RootFilter appears
75	* as another Filter to the rest of the Filter tree. This
76	* method is required by the interface, although it actually
77	* returns null.
78	*
79	* @return null
80	*/
81	public String getUDPPort() {
82	return null;
83	}
84
85	/**
86	* This method is provided because the RootFilter appears
87	* as another Filter to the rest of the Filter tree. This
88	* method is required by the interface, although it actually
89	* returns null.
90	*
91	* @return null
92	*/
93	public String getTCPPort() {
94	return null;
95	}
96
97	/**
98	* This method is provided because the RootFilter appears
99	* as another Filter to the rest of the Filter tree. This
100	* method is required by the interface, although it actually
101	* returns null.
102	*
103	* @return null
104	*/
105	public String getHostName() {
106	return null;
107	}
108
109	//---ATTRIBUTES---
110
111	/**
112	* This is the friendly identifier of the
113	* component this class is running in.
114	* eg, a Filter may be called "filter1",
115	* If this class does not have an owning
116	* component, a name from the configuration
117	* can be placed here. This name could also
118	* be changed to null for utility classes.
119	*/
120	private String _name = RootFilter.NAME;
121
122	/**
123	* This holds a reference to the
124	* system logger that is being used.
125	*/
126	private Logger _logger = ReferenceManager.getInstance().getLogger();
127
128	/**
129	* A reference to the Queue being used.
130	*/
131	private Queue _queue;
132
133	//---STATIC ATTRIBUTES---
134
135	}