1 |
+ |
|
2 |
|
//---PACKAGE DECLARATION--- |
3 |
< |
package uk.ac.ukc.iscream.rootfilter; |
3 |
> |
package uk.org.iscream.rootfilter; |
4 |
|
|
5 |
|
//---IMPORTS--- |
6 |
< |
import uk.ac.ukc.iscream.util.*; |
7 |
< |
import uk.ac.ukc.iscream.core.*; |
6 |
> |
import uk.org.iscream.util.*; |
7 |
> |
import uk.org.iscream.core.*; |
8 |
> |
import uk.org.iscream.componentmanager.*; |
9 |
> |
import uk.org.iscream.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 |
|
|
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) { |
26 |
< |
// *************************************** |
27 |
< |
// VERY TEMPORARY - will find a better way |
28 |
< |
System.setProperty("org.omg.CORBA.ORBClass","jacorb.orb.ORB"); |
29 |
< |
System.setProperty("org.omg.CORBA.ORBSingletonClass","jacorb.orb.ORBSingleton"); |
30 |
< |
// *************************************** |
33 |
> |
//---CONSTRUCTORS--- |
34 |
|
|
35 |
< |
ReferenceManager refman = ReferenceManager.init(null, null); |
33 |
< |
|
34 |
< |
// can't have a real toString() :) |
35 |
< |
String toString = "RootFilter{" + refman.getName() + "}(" + REVISION.substring(11, REVISION.length() - 2) + ")"; |
35 |
> |
//---PUBLIC METHODS--- |
36 |
|
|
37 |
< |
refman.getLogger().write(toString, Logger.SYSINIT, "coming up"); |
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 |
> |
try { |
60 |
> |
realInterface = cp.getProperty(configName, "RootFilter.realtimeInterfaceName"); |
61 |
> |
dbInterface = cp.getProperty(configName, "RootFilter.dbInterfaceName"); |
62 |
> |
} catch (PropertyNotFoundException e) { |
63 |
> |
_logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e); |
64 |
> |
realInterface = null; |
65 |
> |
dbInterface = null; |
66 |
> |
} |
67 |
> |
|
68 |
> |
ClientInterface ciReal = null, ciDB = null; |
69 |
> |
// get reference to the client interfaces - the real time one |
70 |
> |
if (realInterface != null) { |
71 |
> |
ciReal = ClientInterfaceHelper.narrow(_refman.getCORBARef("iscream.ClientInterface." + realInterface)); |
72 |
> |
} |
73 |
> |
// get reference to the client interfaces - and the db one |
74 |
> |
if (dbInterface != null) { |
75 |
> |
ciDB = ClientInterfaceHelper.narrow(_refman.getCORBARef("iscream.ClientInterface." + dbInterface)); |
76 |
> |
} |
77 |
> |
|
78 |
> |
// setup a queue |
79 |
> |
Queue queue; |
80 |
> |
// see if this Queue needs a size limit |
81 |
> |
try { |
82 |
> |
int queueSizeLimit = Integer.parseInt(cp.getProperty(configName, "Queue.SizeLimit")); |
83 |
> |
String queueRemoveAlgorithm = cp.getProperty(configName, "Queue.RemoveAlgorithm"); |
84 |
> |
int algorithm = StringUtils.getStringPos(queueRemoveAlgorithm, Queue.algorithms); |
85 |
> |
if(algorithm != -1) { |
86 |
> |
queue = new Queue(queueSizeLimit, algorithm); |
87 |
> |
} |
88 |
> |
else { |
89 |
> |
_logger.write(toString(), Logger.WARNING, "Bad Queue Algorithm configuration, not known: "+queueRemoveAlgorithm); |
90 |
> |
// just don't activate a limit |
91 |
> |
queue = new Queue(); |
92 |
> |
} |
93 |
|
|
94 |
< |
// configuration variables we require |
95 |
< |
String ourName = null; |
94 |
> |
} catch (PropertyNotFoundException e) { |
95 |
> |
_logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e); |
96 |
> |
// just don't activate a limit |
97 |
> |
queue = new Queue(); |
98 |
> |
} catch (NumberFormatException e) { |
99 |
> |
_logger.write(toString(), Logger.WARNING, "Bad Queue SizeLimit configuration: "+e); |
100 |
> |
// just don't activate a limit |
101 |
> |
queue = new Queue(); |
102 |
> |
} |
103 |
|
|
104 |
< |
Configuration config = refman.getCM().getConfiguration("RootFilter"); |
105 |
< |
if (config == null) { |
106 |
< |
throw new RuntimeException ("CRITICAL:Unable to obtain configuration" + |
107 |
< |
" Advise you check the i-scream log for more information."); |
104 |
> |
// startup a monitor on this queue |
105 |
> |
try { |
106 |
> |
// try to get the interval, if this fails, we won't start up the monitor |
107 |
> |
int queueMonitorInterval = Integer.parseInt(cp.getProperty(configName, "Queue.MonitorInterval")); |
108 |
> |
String queueName = NAME + " RootFilter"; |
109 |
> |
queue.startMonitor(queueMonitorInterval*1000, queueName); |
110 |
> |
} catch (PropertyNotFoundException e) { |
111 |
> |
_logger.write(toString(), Logger.WARNING, "failed to find queue monitor config, disabling. " + e); |
112 |
> |
} |
113 |
> |
|
114 |
> |
if (realInterface == null) { |
115 |
> |
_logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + dbInterface); |
116 |
> |
CIWrapper c = new CIWrapper(ciDB, queue); |
117 |
> |
c.start(); |
118 |
> |
} else if (dbInterface == null) { |
119 |
> |
_logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface); |
120 |
> |
CIWrapper c = new CIWrapper(ciReal, queue); |
121 |
> |
c.start(); |
122 |
|
} else { |
123 |
< |
try { |
124 |
< |
ourName = config.getProperty("Filter.rootFilter"); |
125 |
< |
} catch (org.omg.CORBA.MARSHAL e) { |
126 |
< |
refman.getLogger().write(toString, Logger.FATAL, "required config property not present"); |
127 |
< |
throw new RuntimeException ("CRITICAL:Unable to obtain required configuration property" + |
52 |
< |
" Advise you check the i-scream log for more information."); |
53 |
< |
|
54 |
< |
} |
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 |
|
} |
129 |
< |
// now we have the name of the Root Filter we set it |
130 |
< |
refman.setName(ourName); |
131 |
< |
toString = "RootFilter{" + refman.getName() + "}(" + REVISION.substring(11, REVISION.length() - 2) + ")"; |
132 |
< |
refman.getLogger().write(toString, Logger.SYSINIT, "configured"); |
129 |
> |
|
130 |
> |
// RootFilterServant start (for inbound child filter data) |
131 |
> |
_logger.write(toString(), Logger.DEBUG, "starting Root Filter"); |
132 |
> |
RootFilterServant filterServant = new RootFilterServant(queue); |
133 |
> |
// bind to the naming service as a filter |
134 |
> |
_refman.bindToOrb(filterServant, "iscream.Filter." + RootFilter.NAME); |
135 |
|
|
136 |
< |
// FilterServant start (for inbound child filter data) |
62 |
< |
refman.getLogger().write(toString, Logger.DEBUG, "starting Root Filter"); |
63 |
< |
RootFilterServant filterServant = new RootFilterServant(); |
64 |
< |
refman.bindToOrb(filterServant, "iscream.Filter." + refman.getName()); |
136 |
> |
_logger.write(toString(), Logger.SYSINIT, "started"); |
137 |
|
|
66 |
– |
// start the POA off |
67 |
– |
// now we are running, we just need to serve |
68 |
– |
// so we ask the orb to block for us until it has finished |
69 |
– |
refman.activatePOA(); |
70 |
– |
refman.getLogger().write(toString, Logger.SYSINIT, "started"); |
71 |
– |
refman.getORB().run(); |
138 |
|
} |
139 |
< |
|
140 |
< |
/** |
141 |
< |
* A simple method to print the usage of this class. |
142 |
< |
* It never returns, but instead exits to the system |
143 |
< |
* with a value 1, to indicate the system did not start |
144 |
< |
* properly. |
139 |
> |
|
140 |
> |
/** |
141 |
> |
* Does a dependency check. Used mainly at startup to |
142 |
> |
* see if the required dependencies (components) are up |
143 |
> |
* and running. |
144 |
> |
* |
145 |
> |
* @return a boolean value, true if the depdencies are satisfied |
146 |
|
*/ |
147 |
< |
public static void usage() { |
148 |
< |
System.out.println("USAGE: java FilterMain <name>"); |
149 |
< |
System.out.println("WHERE <name>:"); |
150 |
< |
System.out.println(" The unique identifier for the Filter in the system."); |
151 |
< |
System.exit(1); |
147 |
> |
public boolean depCheck() { |
148 |
> |
try { |
149 |
> |
org.omg.CORBA.Object obj; |
150 |
> |
// first check the ConfigurationManager is alive |
151 |
> |
obj = _refman.getCORBARef("iscream.ConfigurationManager"); |
152 |
> |
// then get some info on the CLI and DBI |
153 |
> |
ConfigurationProxy cp = ConfigurationProxy.getInstance(); |
154 |
> |
String cli = cp.getProperty("RootFilter", "RootFilter.realtimeInterfaceName"); |
155 |
> |
String dbi = cp.getProperty("RootFilter", "RootFilter.dbInterfaceName"); |
156 |
> |
// finally check the CLI and DBI are alive |
157 |
> |
obj = _refman.getCORBARef("iscream.ClientInterface." + cli); |
158 |
> |
obj = _refman.getCORBARef("iscream.ClientInterface." + dbi); |
159 |
> |
} catch(ComponentCORBAException e) { |
160 |
> |
System.err.println(toString() + ": Dependency Failure: "+e); |
161 |
> |
return false; |
162 |
> |
} catch(PropertyNotFoundException e) { |
163 |
> |
System.err.println(toString() + ": Unable to obtain configuration: "+e); |
164 |
> |
return false; |
165 |
> |
} |
166 |
> |
// dependency check suceeded |
167 |
> |
return true; |
168 |
|
} |
169 |
+ |
|
170 |
+ |
/** |
171 |
+ |
* Overrides the {@link java.lang.Object#toString() Object.toString()} |
172 |
+ |
* method to provide clean logging (every class should have this). |
173 |
+ |
* |
174 |
+ |
* This uses the uk.org.iscream.util.NameFormat class |
175 |
+ |
* to format the toString() |
176 |
+ |
* |
177 |
+ |
* @return the name of this class and its CVS revision |
178 |
+ |
*/ |
179 |
+ |
public String toString() { |
180 |
+ |
return FormatName.getName( |
181 |
+ |
NAME, |
182 |
+ |
getClass().getName(), |
183 |
+ |
REVISION); |
184 |
+ |
} |
185 |
|
|
87 |
– |
//---CONSTRUCTORS--- |
88 |
– |
|
89 |
– |
//---PUBLIC METHODS--- |
90 |
– |
|
186 |
|
//---PRIVATE METHODS--- |
187 |
|
|
188 |
|
//---ACCESSOR/MUTATOR METHODS--- |
189 |
|
|
190 |
|
//---ATTRIBUTES--- |
191 |
|
|
192 |
+ |
/** |
193 |
+ |
* This holds a reference to the |
194 |
+ |
* system logger that is being used. |
195 |
+ |
*/ |
196 |
+ |
private Logger _logger; |
197 |
+ |
|
198 |
+ |
/** |
199 |
+ |
* A reference to the reference manager in use |
200 |
+ |
*/ |
201 |
+ |
private ReferenceManager _refman = ReferenceManager.getInstance(); |
202 |
+ |
|
203 |
|
//---STATIC ATTRIBUTES--- |
204 |
+ |
|
205 |
+ |
/** |
206 |
+ |
* The friendly name for this component, used by |
207 |
+ |
* all related classes. |
208 |
+ |
* This is set from the configuration. |
209 |
+ |
*/ |
210 |
+ |
public static String NAME; |
211 |
|
|
212 |
|
} |