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.10 by ajm, Tue Dec 12 19:54:55 2000 UTC vs.
Revision 1.40 by tdb, Tue May 21 16:47:18 2002 UTC

# Line 1 | Line 1
1 + /*
2 + * i-scream central monitoring system
3 + * http://www.i-scream.org.uk
4 + * Copyright (C) 2000-2002 i-scream
5 + *
6 + * This program is free software; you can redistribute it and/or
7 + * modify it under the terms of the GNU General Public License
8 + * as published by the Free Software Foundation; either version 2
9 + * of the License, or (at your option) any later version.
10 + *
11 + * This program is distributed in the hope that it will be useful,
12 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 + * GNU General Public License for more details.
15 + *
16 + * You should have received a copy of the GNU General Public License
17 + * along with this program; if not, write to the Free Software
18 + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19 + */
20 +
21 +
22   //---PACKAGE DECLARATION---
23 < package uk.ac.ukc.iscream.rootfilter;
23 > package uk.org.iscream.cms.server.rootfilter;
24  
25   //---IMPORTS---
26 < import uk.ac.ukc.iscream.util.*;
27 < import uk.ac.ukc.iscream.core.*;
28 < import uk.ac.ukc.iscream.clientinterface.*;
26 > import uk.org.iscream.cms.server.util.*;
27 > import uk.org.iscream.cms.server.core.*;
28 > import uk.org.iscream.cms.server.componentmanager.*;
29 > import uk.org.iscream.cms.server.clientinterface.*;
30  
31   /**
32   * The root filter is what all filters talk to
# Line 17 | Line 39 | import uk.ac.ukc.iscream.clientinterface.*;
39   * @author  $Author$
40   * @version $Id$
41   */
42 < public class RootFilter implements uk.ac.ukc.iscream.util.Component {
42 > public class RootFilter implements Component {
43  
44   //---FINAL ATTRIBUTES---
45  
# Line 36 | Line 58 | public class RootFilter implements uk.ac.ukc.iscream.u
58       * This starts the Root Filter for the system
59       */
60      public void start() throws ComponentStartException {
61 <
61 >        // get references to key objects
62 >        _logger = _refman.getLogger();
63 >        
64          _logger.write(toString(), Logger.SYSINIT, "coming up");
41            
42        // configuration variables we require
43        String ourName = null;
44        String realInterface = null;
45        String dbInterface = null;
65          
66 <        Configuration config = _refman.getCM().getConfiguration("RootFilter");
67 <        if (config == null) {
68 <            System.err.println("CRITICAL:Unable to obtain configuration" +
69 <                               "\n         Advise you check the i-scream log for more information.");
70 <            _logger.write(toString(), Logger.FATAL, "ERROR - unable to obtain configuration");
71 <            System.exit(1);
72 <        } else {
73 <            try {
74 <                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 <                System.err.println ("CRITICAL:Unable to obtain required configuration property" +
60 <                                    "\n         Advise you check the i-scream log for more information.");
61 <                _logger.write(toString(), Logger.FATAL, "ERROR - required configuration property not present");
62 <                System.exit(1);
63 <            }
66 >        ConfigurationProxy cp = ConfigurationProxy.getInstance();
67 >        String configName = "RootFilter";
68 >        
69 >        // set the name of the root filter
70 >        try {
71 >            NAME = cp.getProperty(configName, "RootFilter.name");
72 >        } catch (PropertyNotFoundException e) {
73 >            NAME = null;
74 >            _logger.write(toString(), Logger.WARNING, "RootFilter name not set: "+e);
75          }
65        // now we have the name of the Root Filter we set it
66        NAME = ourName;
76          
77 <        _logger.write(toString(), Logger.SYSINIT, "configured");
78 <                
77 >        // try and get the names of the ciReal and ciDB
78 >        String realInterface, dbInterface;
79 >        // first realtime
80 >        try {
81 >            realInterface = cp.getProperty(configName, "RootFilter.realtimeInterfaceName");
82 >        } catch (PropertyNotFoundException e) {
83 >            _logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
84 >            realInterface = null;
85 >        }
86 >        // next dbi
87 >        try {
88 >            dbInterface = cp.getProperty(configName, "RootFilter.dbInterfaceName");
89 >        } catch (PropertyNotFoundException e) {
90 >            _logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
91 >            dbInterface = null;
92 >        }
93 >        
94 >        ClientInterface ciReal = null, ciDB = null;
95          // get reference to the client interfaces - the real time one
96 <        ClientInterface ciReal = ClientInterfaceHelper.narrow(_refman.getCORBARef("iscream.ClientInterface." + realInterface));
96 >        if (realInterface != null) {
97 >            ciReal = ClientInterfaceHelper.narrow(_refman.getCORBARef("iscream.ClientInterface." + realInterface));
98 >        }
99          // get reference to the client interfaces - and the db one
100 <        ClientInterface ciDB = ClientInterfaceHelper.narrow(_refman.getCORBARef("iscream.ClientInterface." + dbInterface));
101 <        _logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface + " & " + dbInterface);
100 >        if (dbInterface != null) {
101 >            ciDB = ClientInterfaceHelper.narrow(_refman.getCORBARef("iscream.ClientInterface." + dbInterface));
102 >        }
103          
104 <        ClientInterface[] clientInterfaces = {ciReal, ciDB};
104 >        // setup a queue
105 >        Queue queue;
106 >        // see if this Queue needs a size limit
107 >        try {
108 >            int queueSizeLimit = Integer.parseInt(cp.getProperty(configName, "Queue.SizeLimit"));
109 >            String queueRemoveAlgorithm = cp.getProperty(configName, "Queue.RemoveAlgorithm");
110 >            int algorithm = StringUtils.getStringPos(queueRemoveAlgorithm, Queue.algorithms);
111 >            if(algorithm != -1) {
112 >                _logger.write(toString(), Logger.DEBUG, "Starting Queue with size limit of "+queueSizeLimit+", using remove algorithm "+queueRemoveAlgorithm);
113 >                // we have valid values, so lets start it.
114 >                queue = new Queue(queueSizeLimit, algorithm);
115 >            }
116 >            else {
117 >                _logger.write(toString(), Logger.WARNING, "Bad Queue Algorithm configuration, not known: "+queueRemoveAlgorithm);
118 >                // just don't activate a limit
119 >                queue = new Queue();
120 >            }
121 >            
122 >        } catch (PropertyNotFoundException e) {
123 >            _logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
124 >            // just don't activate a limit
125 >            queue = new Queue();
126 >        } catch (NumberFormatException e) {
127 >            _logger.write(toString(), Logger.WARNING, "Bad Queue SizeLimit configuration: "+e);
128 >            // just don't activate a limit
129 >            queue = new Queue();
130 >        }
131          
132 +        // startup a monitor on this queue
133 +        try {
134 +            // try to get the interval, if this fails, we won't start up the monitor
135 +            int queueMonitorInterval = Integer.parseInt(cp.getProperty(configName, "Queue.MonitorInterval"));
136 +            String queueName = NAME + " RootFilter";
137 +            queue.startMonitor(queueMonitorInterval*1000, queueName);
138 +        } catch (PropertyNotFoundException e) {
139 +            _logger.write(toString(), Logger.WARNING, "failed to find queue monitor config, disabling. " + e);
140 +        }
141 +        
142 +        if (realInterface != null && dbInterface != null) {
143 +            _logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface + " & " + dbInterface);
144 +            CIWrapper c = new CIWrapper(ciReal, queue);
145 +            c.start();
146 +            c = new CIWrapper(ciDB, queue);
147 +            c.start();
148 +        } else if (realInterface == null) {        
149 +            _logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + dbInterface);
150 +            CIWrapper c = new CIWrapper(ciDB, queue);
151 +            c.start();
152 +        } else if (dbInterface == null) {
153 +            _logger.write(toString(), Logger.DEBUG, "hooked to interfaces - " + realInterface);
154 +            CIWrapper c = new CIWrapper(ciReal, queue);
155 +            c.start();
156 +        } else {
157 +            _logger.write(toString(), Logger.WARNING, "not hooked to any client interfaces, this is probably not intentional!");
158 +        }
159 +                
160          // RootFilterServant start (for inbound child filter data)
161          _logger.write(toString(), Logger.DEBUG, "starting Root Filter");
162 <        RootFilterServant filterServant = new RootFilterServant(clientInterfaces);
162 >        RootFilterServant filterServant = new RootFilterServant(queue);
163          // bind to the naming service as a filter
164 <        _refman.bindToOrb(filterServant, "iscream.Filter." + _name);
164 >        _refman.bindToOrb(filterServant, "iscream.Filter." + RootFilter.NAME);
165          
166          _logger.write(toString(), Logger.SYSINIT, "started");
167 +        
168      }
169      
170      /**
171 +     * Does a dependency check. Used mainly at startup to
172 +     * see if the required dependencies (components) are up
173 +     * and running.
174 +     *
175 +     * @return a boolean value, true if the depdencies are satisfied
176 +     */
177 +    public boolean depCheck() {
178 +        org.omg.CORBA.Object obj;
179 +        
180 +        // first we need to check the Configuration system is available
181 +        try {
182 +            // first check the ConfigurationManager is alive
183 +            obj = _refman.getCORBARef("iscream.ConfigurationManager");
184 +        } catch(ComponentCORBAException e) {
185 +            System.err.println(toString() + ": Dependency Failure: "+e);
186 +            return false;
187 +        }
188 +        
189 +        // next we need to check which client interfaces *should*
190 +        // be active, and check them. Note they do not have to
191 +        // be enabled, and we should check this.
192 +        // -- each check only forces a dependency if it's configured
193 +        ConfigurationProxy cp = ConfigurationProxy.getInstance();
194 +        // first check the client interface
195 +        try {
196 +            String cli = cp.getProperty("RootFilter", "RootFilter.realtimeInterfaceName");
197 +            obj = _refman.getCORBARef("iscream.ClientInterface." + cli);
198 +        } catch(ComponentCORBAException e) {
199 +            System.err.println(toString() + ": Dependency Failure: "+e);
200 +            return false;
201 +        } catch(PropertyNotFoundException e) {
202 +            System.err.println(toString() + ": Client interface not configured and thus not enabled.");
203 +        }
204 +        // second check the database interface
205 +        try {
206 +            String dbi = cp.getProperty("RootFilter", "RootFilter.dbInterfaceName");
207 +            obj = _refman.getCORBARef("iscream.ClientInterface." + dbi);
208 +        } catch(ComponentCORBAException e) {
209 +            System.err.println(toString() + ": Dependency Failure: "+e);
210 +            return false;
211 +        } catch(PropertyNotFoundException e) {
212 +            System.err.println(toString() + ": Database interface not configured and thus not enabled.");
213 +        }
214 +        
215 +        // dependency check suceeded
216 +        return true;
217 +    }
218 +    
219 +    /**
220       * Overrides the {@link java.lang.Object#toString() Object.toString()}
221       * method to provide clean logging (every class should have this).
222       *
223 <     * This uses the uk.ac.ukc.iscream.util.NameFormat class
223 >     * This uses the uk.org.iscream.cms.server.util.NameFormat class
224       * to format the toString()
225       *
226       * @return the name of this class and its CVS revision
227       */
228      public String toString() {
229          return FormatName.getName(
230 <            _name,
230 >            NAME,
231              getClass().getName(),
232              REVISION);
233      }
# Line 107 | Line 239 | public class RootFilter implements uk.ac.ukc.iscream.u
239   //---ATTRIBUTES---
240  
241      /**
110     * This is the friendly identifier of the
111     * component this class is running in.
112     * eg, a Filter may be called "filter1",
113     * If this class does not have an owning
114     * component,  a name from the configuration
115     * can be placed here.  This name could also
116     * be changed to null for utility classes.
117     */
118    private String _name = RootFilter.NAME;
119
120    /**
242       * This holds a reference to the
243       * system logger that is being used.
244       */
245 <    private Logger _logger = ReferenceManager.getInstance().getLogger();
245 >    private Logger _logger;
246  
247      /**
248       * A reference to the reference manager in use

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines