server/rootfilter/RootFilter.java


//---PACKAGE DECLARATION---
package uk.org.iscream.cms.server.rootfilter;

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

/**
 * The root filter is what all filters talk to
 * Hosts cannot talk to this implementation of a filter.
 * It provides hooks to all data interfaces for the system
 * namely the client interface and the db interface.
 * This is an i-scream component that starts the
 * RootFilter services.
 *
 * @author  $Author: tdb1 $
 * @version $Id: RootFilter.java,v 1.37 2001/03/23 05:30:44 tdb1 Exp $
 */
public class RootFilter implements Component {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.37 $";

//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---

    /**
     * This starts the Root Filter for the system
     */
    public void start() throws ComponentStartException {
        // get references to key objects
        _logger = _refman.getLogger();
        
        _logger.write(toString(), Logger.SYSINIT, "coming up");
        
        ConfigurationProxy cp = ConfigurationProxy.getInstance();
        String configName = "RootFilter";
        
        // set the name of the root filter
        try {
            NAME = cp.getProperty(configName, "RootFilter.name");
        } catch (PropertyNotFoundException e) {
            NAME = null;
            _logger.write(toString(), Logger.WARNING, "RootFilter name not set: "+e);
        }
        
        // try and get the names of the ciReal and ciDB
        String realInterface, dbInterface;
        // first realtime
        try {
            realInterface = cp.getProperty(configName, "RootFilter.realtimeInterfaceName");
        } catch (PropertyNotFoundException e) {
            _logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
            realInterface = null;
        }
        // next dbi
        try {
            dbInterface = cp.getProperty(configName, "RootFilter.dbInterfaceName");
        } catch (PropertyNotFoundException e) {
            _logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
            dbInterface = null;
        }
        
        ClientInterface ciReal = null, ciDB = null;
        // get reference to the client interfaces - the real time one
        if (realInterface != null) {
            ciReal = ClientInterfaceHelper.narrow(_refman.getCORBARef("iscream.ClientInterface." + realInterface));
        }
        // get reference to the client interfaces - and the db one
        if (dbInterface != null) {
            ciDB = ClientInterfaceHelper.narrow(_refman.getCORBARef("iscream.ClientInterface." + dbInterface));
        }
        
        // setup a queue
        Queue queue;
        // see if this Queue needs a size limit
        try {
            int queueSizeLimit = Integer.parseInt(cp.getProperty(configName, "Queue.SizeLimit"));
            String queueRemoveAlgorithm = cp.getProperty(configName, "Queue.RemoveAlgorithm");
            int algorithm = StringUtils.getStringPos(queueRemoveAlgorithm, Queue.algorithms);
            if(algorithm != -1) {
                _logger.write(toString(), Logger.DEBUG, "Starting Queue with size limit of "+queueSizeLimit+", using remove algorithm "+queueRemoveAlgorithm);
                // we have valid values, so lets start it.
                queue = new Queue(queueSizeLimit, algorithm);
            }
            else {
                _logger.write(toString(), Logger.WARNING, "Bad Queue Algorithm configuration, not known: "+queueRemoveAlgorithm);
                // just don't activate a limit
                queue = new Queue();
            }
            
        } catch (PropertyNotFoundException e) {
            _logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
            // just don't activate a limit
            queue = new Queue();
        } catch (NumberFormatException e) {
            _logger.write(toString(), Logger.WARNING, "Bad Queue SizeLimit configuration: "+e);
            // just don't activate a limit
            queue = new Queue();
        }
        
        // startup a monitor on this queue
        try {
            // try to get the interval, if this fails, we won't start up the monitor
            int queueMonitorInterval = Integer.parseInt(cp.getProperty(configName, "Queue.MonitorInterval"));
            String queueName = NAME + " RootFilter";
            queue.startMonitor(queueMonitorInterval*1000, queueName);
        } catch (PropertyNotFoundException e) {
            _logger.write(toString(), Logger.WARNING, "failed to find queue monitor config, disabling. " + e);
        }
        
        if (realInterface != null && dbInterface != null) {
            _logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface + " & " + dbInterface);
            CIWrapper c = new CIWrapper(ciReal, queue);
            c.start();
            c = new CIWrapper(ciDB, queue);
            c.start();
        } else if (realInterface == null) {        
            _logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + dbInterface);
            CIWrapper c = new CIWrapper(ciDB, queue);
            c.start();
        } else if (dbInterface == null) {
            _logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface);
            CIWrapper c = new CIWrapper(ciReal, queue);
            c.start();
        } else {
            _logger.write(toString(), Logger.WARNING, "not hooked to any client interfaces, this is probably not intentional!");
        }
                
        // RootFilterServant start (for inbound child filter data)
        _logger.write(toString(), Logger.DEBUG, "starting Root Filter");
        RootFilterServant filterServant = new RootFilterServant(queue);
        // bind to the naming service as a filter
        _refman.bindToOrb(filterServant, "iscream.Filter." + RootFilter.NAME);
        
        _logger.write(toString(), Logger.SYSINIT, "started");
        
    }
    
    /**
     * Does a dependency check. Used mainly at startup to
     * see if the required dependencies (components) are up
     * and running.
     *
     * @return a boolean value, true if the depdencies are satisfied
     */
    public boolean depCheck() {
        org.omg.CORBA.Object obj;
        
        // first we need to check the Configuration system is available
        try {
            // first check the ConfigurationManager is alive
            obj = _refman.getCORBARef("iscream.ConfigurationManager");
        } catch(ComponentCORBAException e) {
            System.err.println(toString() + ": Dependency Failure: "+e);
            return false;
        }
        
        // next we need to check which client interfaces *should*
        // be active, and check them. Note they do not have to
        // be enabled, and we should check this.
        // -- each check only forces a dependency if it's configured
        ConfigurationProxy cp = ConfigurationProxy.getInstance();
        // first check the client interface
        try {
            String cli = cp.getProperty("RootFilter", "RootFilter.realtimeInterfaceName");
            obj = _refman.getCORBARef("iscream.ClientInterface." + cli);
        } catch(ComponentCORBAException e) {
            System.err.println(toString() + ": Dependency Failure: "+e);
            return false;
        } catch(PropertyNotFoundException e) {
            System.err.println(toString() + ": Client interface not configured and thus not enabled.");
        }
        // second check the database interface
        try {
            String dbi = cp.getProperty("RootFilter", "RootFilter.dbInterfaceName");
            obj = _refman.getCORBARef("iscream.ClientInterface." + dbi);
        } catch(ComponentCORBAException e) {
            System.err.println(toString() + ": Dependency Failure: "+e);
            return false;
        } catch(PropertyNotFoundException e) {
            System.err.println(toString() + ": Database interface not configured and thus not enabled.");
        }
        
        // dependency check suceeded
        return true;
    }
    
    /**
     * 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 holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger;

    /**
     * A reference to the reference manager in use
     */
    private ReferenceManager _refman = ReferenceManager.getInstance();

//---STATIC ATTRIBUTES---

    /**
     * The friendly name for this component, used by
     * all related classes.
     * This is set from the configuration.
     */
    public static String NAME;

}            
Revision:	1.38
Committed:	Tue May 29 17:02:35 2001 UTC (22 years, 11 months ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PIRCBOT
Changes since 1.37:	+8 -8 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
2	//---PACKAGE DECLARATION---
3	package uk.org.iscream.cms.server.rootfilter;
4
5	//---IMPORTS---
6	import uk.org.iscream.cms.server.util.*;
7	import uk.org.iscream.cms.server.core.*;
8	import uk.org.iscream.cms.server.componentmanager.*;
9	import uk.org.iscream.cms.server.clientinterface.*;
10
11	/**
12	* The root filter is what all filters talk to
13	* Hosts cannot talk to this implementation of a filter.
14	* It provides hooks to all data interfaces for the system
15	* namely the client interface and the db interface.
16	* This is an i-scream component that starts the
17	* RootFilter services.
18	*
19	* @author $Author: tdb1 $
20	* @version $Id: RootFilter.java,v 1.37 2001/03/23 05:30:44 tdb1 Exp $
21	*/
22	public class RootFilter implements Component {
23
24	//---FINAL ATTRIBUTES---
25
26	/**
27	* The current CVS revision of this class
28	*/
29	public static final String REVISION = "$Revision: 1.37 $";
30
31	//---STATIC METHODS---
32
33	//---CONSTRUCTORS---
34
35	//---PUBLIC METHODS---
36
37	/**
38	* This starts the Root Filter for the system
39	*/
40	public void start() throws ComponentStartException {
41	// get references to key objects
42	_logger = _refman.getLogger();
43
44	_logger.write(toString(), Logger.SYSINIT, "coming up");
45
46	ConfigurationProxy cp = ConfigurationProxy.getInstance();
47	String configName = "RootFilter";
48
49	// set the name of the root filter
50	try {
51	NAME = cp.getProperty(configName, "RootFilter.name");
52	} catch (PropertyNotFoundException e) {
53	NAME = null;
54	_logger.write(toString(), Logger.WARNING, "RootFilter name not set: "+e);
55	}
56
57	// try and get the names of the ciReal and ciDB
58	String realInterface, dbInterface;
59	// first realtime
60	try {
61	realInterface = cp.getProperty(configName, "RootFilter.realtimeInterfaceName");
62	} catch (PropertyNotFoundException e) {
63	_logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
64	realInterface = null;
65	}
66	// next dbi
67	try {
68	dbInterface = cp.getProperty(configName, "RootFilter.dbInterfaceName");
69	} catch (PropertyNotFoundException e) {
70	_logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
71	dbInterface = null;
72	}
73
74	ClientInterface ciReal = null, ciDB = null;
75	// get reference to the client interfaces - the real time one
76	if (realInterface != null) {
77	ciReal = ClientInterfaceHelper.narrow(_refman.getCORBARef("iscream.ClientInterface." + realInterface));
78	}
79	// get reference to the client interfaces - and the db one
80	if (dbInterface != null) {
81	ciDB = ClientInterfaceHelper.narrow(_refman.getCORBARef("iscream.ClientInterface." + dbInterface));
82	}
83
84	// setup a queue
85	Queue queue;
86	// see if this Queue needs a size limit
87	try {
88	int queueSizeLimit = Integer.parseInt(cp.getProperty(configName, "Queue.SizeLimit"));
89	String queueRemoveAlgorithm = cp.getProperty(configName, "Queue.RemoveAlgorithm");
90	int algorithm = StringUtils.getStringPos(queueRemoveAlgorithm, Queue.algorithms);
91	if(algorithm != -1) {
92	_logger.write(toString(), Logger.DEBUG, "Starting Queue with size limit of "+queueSizeLimit+", using remove algorithm "+queueRemoveAlgorithm);
93	// we have valid values, so lets start it.
94	queue = new Queue(queueSizeLimit, algorithm);
95	}
96	else {
97	_logger.write(toString(), Logger.WARNING, "Bad Queue Algorithm configuration, not known: "+queueRemoveAlgorithm);
98	// just don't activate a limit
99	queue = new Queue();
100	}
101
102	} catch (PropertyNotFoundException e) {
103	_logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
104	// just don't activate a limit
105	queue = new Queue();
106	} catch (NumberFormatException e) {
107	_logger.write(toString(), Logger.WARNING, "Bad Queue SizeLimit configuration: "+e);
108	// just don't activate a limit
109	queue = new Queue();
110	}
111
112	// startup a monitor on this queue
113	try {
114	// try to get the interval, if this fails, we won't start up the monitor
115	int queueMonitorInterval = Integer.parseInt(cp.getProperty(configName, "Queue.MonitorInterval"));
116	String queueName = NAME + " RootFilter";
117	queue.startMonitor(queueMonitorInterval*1000, queueName);
118	} catch (PropertyNotFoundException e) {
119	_logger.write(toString(), Logger.WARNING, "failed to find queue monitor config, disabling. " + e);
120	}
121
122	if (realInterface != null && dbInterface != null) {
123	_logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface + " & " + dbInterface);
124	CIWrapper c = new CIWrapper(ciReal, queue);
125	c.start();
126	c = new CIWrapper(ciDB, queue);
127	c.start();
128	} else if (realInterface == null) {
129	_logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + dbInterface);
130	CIWrapper c = new CIWrapper(ciDB, queue);
131	c.start();
132	} else if (dbInterface == null) {
133	_logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface);
134	CIWrapper c = new CIWrapper(ciReal, queue);
135	c.start();
136	} else {
137	_logger.write(toString(), Logger.WARNING, "not hooked to any client interfaces, this is probably not intentional!");
138	}
139
140	// RootFilterServant start (for inbound child filter data)
141	_logger.write(toString(), Logger.DEBUG, "starting Root Filter");
142	RootFilterServant filterServant = new RootFilterServant(queue);
143	// bind to the naming service as a filter
144	_refman.bindToOrb(filterServant, "iscream.Filter." + RootFilter.NAME);
145
146	_logger.write(toString(), Logger.SYSINIT, "started");
147
148	}
149
150	/**
151	* Does a dependency check. Used mainly at startup to
152	* see if the required dependencies (components) are up
153	* and running.
154	*
155	* @return a boolean value, true if the depdencies are satisfied
156	*/
157	public boolean depCheck() {
158	org.omg.CORBA.Object obj;
159
160	// first we need to check the Configuration system is available
161	try {
162	// first check the ConfigurationManager is alive
163	obj = _refman.getCORBARef("iscream.ConfigurationManager");
164	} catch(ComponentCORBAException e) {
165	System.err.println(toString() + ": Dependency Failure: "+e);
166	return false;
167	}
168
169	// next we need to check which client interfaces should
170	// be active, and check them. Note they do not have to
171	// be enabled, and we should check this.
172	// -- each check only forces a dependency if it's configured
173	ConfigurationProxy cp = ConfigurationProxy.getInstance();
174	// first check the client interface
175	try {
176	String cli = cp.getProperty("RootFilter", "RootFilter.realtimeInterfaceName");
177	obj = _refman.getCORBARef("iscream.ClientInterface." + cli);
178	} catch(ComponentCORBAException e) {
179	System.err.println(toString() + ": Dependency Failure: "+e);
180	return false;
181	} catch(PropertyNotFoundException e) {
182	System.err.println(toString() + ": Client interface not configured and thus not enabled.");
183	}
184	// second check the database interface
185	try {
186	String dbi = cp.getProperty("RootFilter", "RootFilter.dbInterfaceName");
187	obj = _refman.getCORBARef("iscream.ClientInterface." + dbi);
188	} catch(ComponentCORBAException e) {
189	System.err.println(toString() + ": Dependency Failure: "+e);
190	return false;
191	} catch(PropertyNotFoundException e) {
192	System.err.println(toString() + ": Database interface not configured and thus not enabled.");
193	}
194
195	// dependency check suceeded
196	return true;
197	}
198
199	/**
200	* Overrides the {@link java.lang.Object#toString() Object.toString()}
201	* method to provide clean logging (every class should have this).
202	*
203	* This uses the uk.org.iscream.cms.server.util.NameFormat class
204	* to format the toString()
205	*
206	* @return the name of this class and its CVS revision
207	*/
208	public String toString() {
209	return FormatName.getName(
210	NAME,
211	getClass().getName(),
212	REVISION);
213	}
214
215	//---PRIVATE METHODS---
216
217	//---ACCESSOR/MUTATOR METHODS---
218
219	//---ATTRIBUTES---
220
221	/**
222	* This holds a reference to the
223	* system logger that is being used.
224	*/
225	private Logger _logger;
226
227	/**
228	* A reference to the reference manager in use
229	*/
230	private ReferenceManager _refman = ReferenceManager.getInstance();
231
232	//---STATIC ATTRIBUTES---
233
234	/**
235	* The friendly name for this component, used by
236	* all related classes.
237	* This is set from the configuration.
238	*/
239	public static String NAME;
240
241	}