2 |
|
package uk.ac.ukc.iscream.rootfilter; |
3 |
|
|
4 |
|
//---IMPORTS--- |
5 |
+ |
import uk.ac.ukc.iscream.util.*; |
6 |
|
import uk.ac.ukc.iscream.core.*; |
7 |
< |
import uk.ac.ukc.iscream.filter.*; |
8 |
< |
import org.omg.CORBA.*; |
8 |
< |
import org.omg.CosNaming.*; |
9 |
< |
import org.omg.PortableServer.*; |
7 |
> |
import uk.ac.ukc.iscream.componentmanager.*; |
8 |
> |
import uk.ac.ukc.iscream.clientinterface.*; |
9 |
|
|
10 |
|
/** |
11 |
< |
* A RootFilter Startup Class |
11 |
> |
* The root filter is what all filters talk to |
12 |
> |
* Hosts cannot talk to this implementation of a filter. |
13 |
> |
* It provides hooks to all data interfaces for the system |
14 |
> |
* namely the client interface and the db interface. |
15 |
> |
* This is an i-scream component that starts the |
16 |
> |
* RootFilter services. |
17 |
|
* |
18 |
|
* @author $Author$ |
19 |
|
* @version $Id$ |
20 |
|
*/ |
21 |
< |
class RootFilterMain { |
21 |
> |
public class RootFilter implements Component { |
22 |
|
|
23 |
|
//---FINAL ATTRIBUTES--- |
24 |
|
|
26 |
|
* The current CVS revision of this class |
27 |
|
*/ |
28 |
|
public static final String REVISION = "$Revision$"; |
29 |
< |
|
29 |
> |
|
30 |
|
//---STATIC METHODS--- |
31 |
|
|
32 |
< |
public static void main(String[] args) { |
33 |
< |
System.setProperty("org.omg.CORBA.ORBClass","jacorb.orb.ORB"); |
34 |
< |
System.setProperty("org.omg.CORBA.ORBSingletonClass","jacorb.orb.ORBSingleton"); |
32 |
> |
//---CONSTRUCTORS--- |
33 |
> |
|
34 |
> |
//---PUBLIC METHODS--- |
35 |
> |
|
36 |
> |
/** |
37 |
> |
* This starts the Root Filter for the system |
38 |
> |
*/ |
39 |
> |
public void start() throws ComponentStartException { |
40 |
> |
|
41 |
> |
_logger.write(toString(), Logger.SYSINIT, "coming up"); |
42 |
> |
|
43 |
> |
// configuration variables we require |
44 |
> |
String ourName = null; |
45 |
> |
String realInterface = null; |
46 |
> |
String dbInterface = null; |
47 |
|
|
48 |
< |
// get our name from the command line |
49 |
< |
String ourName = ""; |
50 |
< |
if (args.length == 1) { |
35 |
< |
ourName = args[0]; |
48 |
> |
Configuration config = _refman.getCM().getConfiguration("RootFilter"); |
49 |
> |
if (config == null) { |
50 |
> |
throw new ComponentStartException("Unable to obtain configuration for component"); |
51 |
|
} |
52 |
|
else { |
53 |
< |
usage(); |
53 |
> |
try { |
54 |
> |
// get the configuration properties we need |
55 |
> |
ourName = config.getProperty("RootFilter.name"); |
56 |
> |
realInterface = config.getProperty("RootFilter.realtimeInterfaceName"); |
57 |
> |
dbInterface = config.getProperty("RootFilter.dbInterfaceName"); |
58 |
> |
} catch (org.omg.CORBA.MARSHAL e) { |
59 |
> |
throw new ComponentStartException("Unable to obtain requried configuration property for component"); |
60 |
> |
} |
61 |
|
} |
62 |
|
|
63 |
< |
// can't have a real toString() :) |
64 |
< |
String toString = "RootFilter{" + ourName + "}(" + REVISION.substring(11, REVISION.length() - 2) + ")"; |
63 |
> |
// now we have the name of the Root Filter we set it |
64 |
> |
NAME = ourName; |
65 |
|
|
66 |
< |
try { |
67 |
< |
ORB orb = ORB.init(args, null); |
68 |
< |
|
69 |
< |
// something to hold objects |
70 |
< |
org.omg.CORBA.Object objRef = null; |
71 |
< |
|
50 |
< |
// get the Root POA |
51 |
< |
objRef = orb.resolve_initial_references("RootPOA"); |
52 |
< |
POA poa = POAHelper.narrow(objRef); |
53 |
< |
|
54 |
< |
// get a hook to the name service |
55 |
< |
objRef = orb.resolve_initial_references("NameService"); |
56 |
< |
NamingContextExt ncRef = NamingContextExtHelper.narrow(objRef); |
57 |
< |
|
58 |
< |
// get a ref to the ConfigurationManager, Logger & the FilterManager |
59 |
< |
|
60 |
< |
objRef = ncRef.resolve(ncRef.to_name("iscream.ConfigurationManager")); |
61 |
< |
ConfigurationManager configManager = ConfigurationManagerHelper.narrow(objRef); |
62 |
< |
|
63 |
< |
objRef = ncRef.resolve(ncRef.to_name("iscream.Logger")); |
64 |
< |
Logger logger = LoggerHelper.narrow(objRef); |
65 |
< |
|
66 |
< |
//objRef = ncRef.resolve(ncRef.to_name("iscream.FilterManager")); |
67 |
< |
//FilterManager filterManager = FilterManagerHelper.narrow(objRef); |
68 |
< |
|
69 |
< |
logger.write(toString, Logger.SYSINIT, "coming up"); |
70 |
< |
|
71 |
< |
|
72 |
< |
// **** THIS SECTION WILL NEED CHANGING TO GET RELEVANT CONFIG |
73 |
< |
// **** Please ignore this block of code, it's just "copy/paste" :) |
74 |
< |
|
75 |
< |
// get the config |
76 |
< |
Configuration myConfig = configManager.getConfiguration(ourName); |
77 |
< |
|
78 |
< |
logger.write(toString, Logger.SYSINIT, "configured"); |
79 |
< |
|
80 |
< |
// **** END COMMENT |
81 |
< |
|
82 |
< |
// **** INITIAL FILTER MANAGER COMMUNICATIONS HERE |
83 |
< |
|
84 |
< |
// **** END COMMENT |
85 |
< |
|
86 |
< |
logger.write(toString, Logger.SYSINIT, "starting RootFilter"); |
87 |
< |
|
88 |
< |
/************************************************************** |
89 |
< |
Here would be an ideal place to start another thread to do |
90 |
< |
the listening part of the Filter. Ideally it should just be |
91 |
< |
created and then run(). It may be necessary to pass some of |
92 |
< |
the following parameters into the thread by the constructor. |
93 |
< |
|
94 |
< |
Logger logger |
95 |
< |
- a reference to a Logger object |
96 |
< |
FilterManager filterManager |
97 |
< |
- a reference to the system filter manager |
98 |
< |
ConfigurationManager configManager |
99 |
< |
- a reference to the system configuration manager |
100 |
< |
Configuration myConfig |
101 |
< |
- a reference to the configuration object for this |
102 |
< |
filter instance |
103 |
< |
String ourName |
104 |
< |
- our "identifier" name |
105 |
< |
|
106 |
< |
**************************************************************/ |
107 |
< |
|
108 |
< |
// NOTE: |
109 |
< |
// We will not need to bind to the ORB when the FilterManager |
110 |
< |
// is running :) |
111 |
< |
|
112 |
< |
// create the RootFilterServant |
113 |
< |
RootFilterServant rfServant = new RootFilterServant(logger, ourName); |
114 |
< |
|
115 |
< |
// and advertise it to the naming context |
116 |
< |
objRef = poa.servant_to_reference(rfServant); |
117 |
< |
ncRef.bind(ncRef.to_name("iscream.Filter."+ourName), objRef); |
118 |
< |
|
119 |
< |
// start the POA off |
120 |
< |
poa.the_POAManager().activate(); |
121 |
< |
|
122 |
< |
logger.write(toString, Logger.SYSINIT, "started"); |
123 |
< |
|
124 |
< |
// now we are running, we just need to serve |
125 |
< |
// so we ask the orb to block for us until it has finished |
126 |
< |
orb.run(); |
127 |
< |
|
128 |
< |
} catch (Exception e) { |
129 |
< |
System.err.println("FILTER ERROR: " + e); |
130 |
< |
e.printStackTrace(System.out); |
66 |
> |
_logger.write(toString(), Logger.SYSINIT, "configured"); |
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 |
+ |
Queue queue = new Queue(); |
79 |
+ |
// startup a monitor on this queue, every minute |
80 |
+ |
queue.startMonitor(60*1000, NAME); |
81 |
+ |
|
82 |
+ |
if (realInterface == null) { |
83 |
+ |
_logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + dbInterface); |
84 |
+ |
CIWrapper c = new CIWrapper(ciDB, queue); |
85 |
+ |
c.start(); |
86 |
+ |
} else if (dbInterface == null) { |
87 |
+ |
_logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface); |
88 |
+ |
CIWrapper c = new CIWrapper(ciReal, queue); |
89 |
+ |
c.start(); |
90 |
+ |
} else { |
91 |
+ |
_logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface + " & " + dbInterface); |
92 |
+ |
CIWrapper c = new CIWrapper(ciReal, queue); |
93 |
+ |
c.start(); |
94 |
+ |
c = new CIWrapper(ciDB, queue); |
95 |
+ |
c.start(); |
96 |
+ |
} |
97 |
+ |
|
98 |
+ |
// RootFilterServant start (for inbound child filter data) |
99 |
+ |
_logger.write(toString(), Logger.DEBUG, "starting Root Filter"); |
100 |
+ |
RootFilterServant filterServant = new RootFilterServant(queue); |
101 |
+ |
// bind to the naming service as a filter |
102 |
+ |
_refman.bindToOrb(filterServant, "iscream.Filter." + RootFilter.NAME); |
103 |
+ |
|
104 |
+ |
_logger.write(toString(), Logger.SYSINIT, "started"); |
105 |
+ |
|
106 |
|
} |
107 |
< |
|
108 |
< |
/** |
109 |
< |
* A simple method to print the usage of this class. |
110 |
< |
* It never returns, but instead exits to the system |
111 |
< |
* with a value 1, to indicate the system did not start |
112 |
< |
* properly. |
107 |
> |
|
108 |
> |
/** |
109 |
> |
* Overrides the {@link java.lang.Object#toString() Object.toString()} |
110 |
> |
* method to provide clean logging (every class should have this). |
111 |
> |
* |
112 |
> |
* This uses the uk.ac.ukc.iscream.util.NameFormat class |
113 |
> |
* to format the toString() |
114 |
> |
* |
115 |
> |
* @return the name of this class and its CVS revision |
116 |
|
*/ |
117 |
< |
public static void usage() { |
118 |
< |
System.out.println("USAGE: java RootFilter <name>"); |
119 |
< |
System.out.println("WHERE <name>:"); |
120 |
< |
System.out.println(" The unique identifier for the RootFilter in the system."); |
121 |
< |
System.exit(1); |
117 |
> |
public String toString() { |
118 |
> |
return FormatName.getName( |
119 |
> |
NAME, |
120 |
> |
getClass().getName(), |
121 |
> |
REVISION); |
122 |
|
} |
123 |
|
|
147 |
– |
//---CONSTRUCTORS--- |
148 |
– |
|
149 |
– |
//---PUBLIC METHODS--- |
150 |
– |
|
124 |
|
//---PRIVATE METHODS--- |
125 |
|
|
126 |
|
//---ACCESSOR/MUTATOR METHODS--- |
127 |
|
|
128 |
|
//---ATTRIBUTES--- |
129 |
|
|
130 |
+ |
/** |
131 |
+ |
* This holds a reference to the |
132 |
+ |
* system logger that is being used. |
133 |
+ |
*/ |
134 |
+ |
private Logger _logger = ReferenceManager.getInstance().getLogger(); |
135 |
+ |
|
136 |
+ |
/** |
137 |
+ |
* A reference to the reference manager in use |
138 |
+ |
*/ |
139 |
+ |
private ReferenceManager _refman = ReferenceManager.getInstance(); |
140 |
+ |
|
141 |
|
//---STATIC ATTRIBUTES--- |
142 |
+ |
|
143 |
+ |
/** |
144 |
+ |
* The friendly name for this component, used by |
145 |
+ |
* all related classes. |
146 |
+ |
* This is set from the configuration. |
147 |
+ |
*/ |
148 |
+ |
public static String NAME; |
149 |
|
|
150 |
< |
} |
150 |
> |
} |