ViewVC Help

View File | Revision Log | Show Annotations | Revision Graph | Root Listing

root/i-scream/projects/cms/source/server/uk/org/iscream/cms/server/rootfilter/RootFilter.java

Comparing projects/cms/source/server/uk/org/iscream/cms/server/rootfilter/RootFilter.java (file contents):
Revision 1.8 by ajm, Mon Dec 4 18:12:13 2000 UTC vs.
Revision 1.38 by tdb, Tue May 29 17:02:35 2001 UTC

#	Line 1 | Line 1
1	+
2		//---PACKAGE DECLARATION---
3	<	package uk.ac.ukc.iscream.rootfilter;
3	>	package uk.org.iscream.cms.server.rootfilter;
4
5		//---IMPORTS---
6	<	import uk.ac.ukc.iscream.util.*;
7	<	import uk.ac.ukc.iscream.core.*;
8	<	import uk.ac.ukc.iscream.clientinterface.*;
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	<	* A Filter Startup Class
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$
20		* @version $Id$
21		*/
22	<	class RootFilterMain {
22	>	public class RootFilter implements Component {
23
24		//---FINAL ATTRIBUTES---
25
#	Line 20 | Line 27 | class RootFilterMain {
27		* The current CVS revision of this class
28		*/
29		public static final String REVISION = "$Revision$";
30	<
30	>
31		//---STATIC METHODS---
32
33	<	public static void main(String[] args) {
27	<	// ***************************************
28	<	// VERY TEMPORARY - will find a better way
29	<	System.setProperty("org.omg.CORBA.ORBClass","jacorb.orb.ORB");
30	<	System.setProperty("org.omg.CORBA.ORBSingletonClass","jacorb.orb.ORBSingleton");
31	<	// ***************************************
33	>	//---CONSTRUCTORS---
34
35	<	ReferenceManager refman = ReferenceManager.init(null, null);
34	<
35	<	// can't have a real toString() :)
36	<	String toString = "RootFilter{" + refman.getName() + "}(" + REVISION.substring(11, REVISION.length() - 2) + ")";
35	>	//---PUBLIC METHODS---
36
37	<	refman.getLogger().write(toString, Logger.SYSINIT, "coming up");
38	<
39	<	// configuration variables we require
40	<	String ourName = null;
41	<	String realInterface = null;
42	<	String dbInterface = null;
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	<	Configuration config = refman.getCM().getConfiguration("RootFilter");
45	<	if (config == null) {
46	<	throw new RuntimeException ("CRITICAL:Unable to obtain configuration" +
47	<	"         Advise you check the i-scream log for more information.");
48	<	} else {
49	<	try {
50	<	ourName = config.getProperty("RootFilter.name");
51	<	realInterface = config.getProperty("RootFilter.realtimeInterfaceName");
52	<	dbInterface = config.getProperty("RootFilter.dbInterfaceName");
53	<	} catch (org.omg.CORBA.MARSHAL e) {
54	<	refman.getLogger().write(toString, Logger.FATAL, "required config property not present");
56	<	throw new RuntimeException ("CRITICAL:Unable to obtain required configuration property" +
57	<	"         Advise you check the i-scream log for more information.");
58	<
59	<	}
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	<	// now we have the name of the Root Filter we set it
57	<	refman.setName(ourName);
58	<	toString = "RootFilter{" + refman.getName() + "}(" + REVISION.substring(11, REVISION.length() - 2) + ")";
59	<	refman.getLogger().write(toString, Logger.SYSINIT, "configured");
60	<
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	<	ClientInterface ciReal = ClientInterfaceHelper.narrow(refman.getCORBARef("iscream.ClientInterface." + realInterface));
77	<	// - the db one ... but it's not done yet
78	<	//ClientInterface ciDB = ClientInterfaceHelper.narrow(refman.getCORBARef("iscream.ClientInterface." + dbInterface));
79	<	// so for the time being we null it.
80	<	ClientInterface ciDB = null;
81	<	refman.getLogger().write(toString, Logger.DEBUG, "hooked to interfaces - " + realInterface + " & " + dbInterface);
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	<	ClientInterface[] clientInterfaces = {ciReal, ciDB};
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	<	refman.getLogger().write(toString, Logger.DEBUG, "starting Root Filter");
142	<	RootFilterServant filterServant = new RootFilterServant(clientInterfaces);
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." + refman.getName());
144	>	_refman.bindToOrb(filterServant, "iscream.Filter." + RootFilter.NAME);
145
146	<	// start the POA off
147	<	// now we are running, we just need to serve
84	<	// so we ask the orb to block for us until it has finished
85	<	refman.activatePOA();
86	<	refman.getLogger().write(toString, Logger.SYSINIT, "started");
87	<	refman.getORB().run();
146	>	_logger.write(toString(), Logger.SYSINIT, "started");
147	>
148		}
149	<
150	<	/**
151	<	* A simple method to print the usage of this class.
152	<	* It never returns, but instead exits to the system
153	<	* with a value 1, to indicate the system did not start
154	<	* properly.
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 static void usage() {
158	<	System.out.println("USAGE: java FilterMain <name>");
159	<	System.out.println("WHERE <name>:");
160	<	System.out.println("      The unique identifier for the Filter in the system.");
161	<	System.exit(1);
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
103	–	//---CONSTRUCTORS---
104	–
105	–	//---PUBLIC METHODS---
106	–
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		}

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines