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
(Generate patch)

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.35 by tdb, Fri Mar 23 04:57:09 2001 UTC

# Line 1 | Line 1
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.*;
8 < import uk.ac.ukc.iscream.clientinterface.*;
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  
# 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 >        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 <        ClientInterface ciReal = ClientInterfaceHelper.narrow(refman.getCORBARef("iscream.ClientInterface." + realInterface));
71 <        // - the db one ... but it's not done yet
72 <        //ClientInterface ciDB = ClientInterfaceHelper.narrow(refman.getCORBARef("iscream.ClientInterface." + dbInterface));
73 <        // so for the time being we null it.
74 <        ClientInterface ciDB = null;
75 <        refman.getLogger().write(toString, Logger.DEBUG, "hooked to interfaces - " + realInterface + " & " + dbInterface);
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 <        ClientInterface[] clientInterfaces = {ciReal, ciDB};
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 >                _logger.write(toString(), Logger.DEBUG, "Starting Queue with size limit of "+queueSizeLimit+", using remove algorithm "+queueRemoveAlgorithm);
87 >                // we have valid values, so lets start it.
88 >                queue = new Queue(queueSizeLimit, algorithm);
89 >            }
90 >            else {
91 >                _logger.write(toString(), Logger.WARNING, "Bad Queue Algorithm configuration, not known: "+queueRemoveAlgorithm);
92 >                // just don't activate a limit
93 >                queue = new Queue();
94 >            }
95 >            
96 >        } catch (PropertyNotFoundException e) {
97 >            _logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
98 >            // just don't activate a limit
99 >            queue = new Queue();
100 >        } catch (NumberFormatException e) {
101 >            _logger.write(toString(), Logger.WARNING, "Bad Queue SizeLimit configuration: "+e);
102 >            // just don't activate a limit
103 >            queue = new Queue();
104 >        }
105          
106 +        // startup a monitor on this queue
107 +        try {
108 +            // try to get the interval, if this fails, we won't start up the monitor
109 +            int queueMonitorInterval = Integer.parseInt(cp.getProperty(configName, "Queue.MonitorInterval"));
110 +            String queueName = NAME + " RootFilter";
111 +            queue.startMonitor(queueMonitorInterval*1000, queueName);
112 +        } catch (PropertyNotFoundException e) {
113 +            _logger.write(toString(), Logger.WARNING, "failed to find queue monitor config, disabling. " + e);
114 +        }
115 +        
116 +        if (realInterface == null) {        
117 +            _logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + dbInterface);
118 +            CIWrapper c = new CIWrapper(ciDB, queue);
119 +            c.start();
120 +        } else if (dbInterface == null) {
121 +            _logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface);
122 +            CIWrapper c = new CIWrapper(ciReal, queue);
123 +            c.start();
124 +        } else {
125 +            _logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface + " & " + dbInterface);
126 +            CIWrapper c = new CIWrapper(ciReal, queue);
127 +            c.start();
128 +            c = new CIWrapper(ciDB, queue);
129 +            c.start();
130 +        }
131 +                
132          // RootFilterServant start (for inbound child filter data)
133 <        refman.getLogger().write(toString, Logger.DEBUG, "starting Root Filter");
134 <        RootFilterServant filterServant = new RootFilterServant(clientInterfaces);
133 >        _logger.write(toString(), Logger.DEBUG, "starting Root Filter");
134 >        RootFilterServant filterServant = new RootFilterServant(queue);
135          // bind to the naming service as a filter
136 <        refman.bindToOrb(filterServant, "iscream.Filter." + refman.getName());
136 >        _refman.bindToOrb(filterServant, "iscream.Filter." + RootFilter.NAME);
137          
138 <        // start the POA off
139 <        // 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();
138 >        _logger.write(toString(), Logger.SYSINIT, "started");
139 >        
140      }
141 <
142 <    /**
143 <     * A simple method to print the usage of this class.
144 <     * It never returns, but instead exits to the system
145 <     * with a value 1, to indicate the system did not start
146 <     * properly.
141 >    
142 >    /**
143 >     * Does a dependency check. Used mainly at startup to
144 >     * see if the required dependencies (components) are up
145 >     * and running.
146 >     *
147 >     * @return a boolean value, true if the depdencies are satisfied
148       */
149 <    public static void usage() {
150 <        System.out.println("USAGE: java FilterMain <name>");
151 <        System.out.println("WHERE <name>:");
152 <        System.out.println("      The unique identifier for the Filter in the system.");
153 <        System.exit(1);
149 >    public boolean depCheck() {
150 >        org.omg.CORBA.Object obj;
151 >        
152 >        // first we need to check the Configuration system is available
153 >        try {
154 >            // first check the ConfigurationManager is alive
155 >            obj = _refman.getCORBARef("iscream.ConfigurationManager");
156 >        } catch(ComponentCORBAException e) {
157 >            System.err.println(toString() + ": Dependency Failure: "+e);
158 >            return false;
159 >        }
160 >        
161 >        // next we need to check which client interfaces *should*
162 >        // be active, and check them. Note they do not have to
163 >        // be enabled, and we should check this.
164 >        // -- each check only forces a dependency if it's configured
165 >        ConfigurationProxy cp = ConfigurationProxy.getInstance();
166 >        // first check the client interface
167 >        try {
168 >            String cli = cp.getProperty("RootFilter", "RootFilter.realtimeInterfaceName");
169 >            obj = _refman.getCORBARef("iscream.ClientInterface." + cli);
170 >        } catch(ComponentCORBAException e) {
171 >            System.err.println(toString() + ": Dependency Failure: "+e);
172 >            return false;
173 >        } catch(PropertyNotFoundException e) {
174 >            System.err.println(toString() + ": Client interface not configured and thus not enabled.");
175 >        }
176 >        // second check the database interface
177 >        try {
178 >            String dbi = cp.getProperty("RootFilter", "RootFilter.dbInterfaceName");
179 >            obj = _refman.getCORBARef("iscream.ClientInterface." + dbi);
180 >        } catch(ComponentCORBAException e) {
181 >            System.err.println(toString() + ": Dependency Failure: "+e);
182 >            return false;
183 >        } catch(PropertyNotFoundException e) {
184 >            System.err.println(toString() + ": Database interface not configured and thus not enabled.");
185 >        }
186 >        
187 >        // dependency check suceeded
188 >        return true;
189      }
190 +    
191 +    /**
192 +     * Overrides the {@link java.lang.Object#toString() Object.toString()}
193 +     * method to provide clean logging (every class should have this).
194 +     *
195 +     * This uses the uk.org.iscream.util.NameFormat class
196 +     * to format the toString()
197 +     *
198 +     * @return the name of this class and its CVS revision
199 +     */
200 +    public String toString() {
201 +        return FormatName.getName(
202 +            NAME,
203 +            getClass().getName(),
204 +            REVISION);
205 +    }
206  
103 //---CONSTRUCTORS---
104
105 //---PUBLIC METHODS---
106
207   //---PRIVATE METHODS---
208  
209   //---ACCESSOR/MUTATOR METHODS---
210  
211   //---ATTRIBUTES---
212  
213 +    /**
214 +     * This holds a reference to the
215 +     * system logger that is being used.
216 +     */
217 +    private Logger _logger;
218 +
219 +    /**
220 +     * A reference to the reference manager in use
221 +     */
222 +    private ReferenceManager _refman = ReferenceManager.getInstance();
223 +
224   //---STATIC ATTRIBUTES---
225 +
226 +    /**
227 +     * The friendly name for this component, used by
228 +     * all related classes.
229 +     * This is set from the configuration.
230 +     */
231 +    public static String NAME;
232  
233   }            

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines