ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/cms/source/server/uk/org/iscream/cms/server/filter/FilterMain.java
(Generate patch)

Comparing projects/cms/source/server/uk/org/iscream/cms/server/filter/FilterMain.java (file contents):
Revision 1.12 by ajm, Wed Nov 29 21:27:39 2000 UTC vs.
Revision 1.38 by tdb, Wed Feb 5 16:43:47 2003 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   //---PACKAGE DECLARATION---
22 < package uk.ac.ukc.iscream.filter;
22 > package uk.org.iscream.cms.server.filter;
23  
24   //---IMPORTS---
25 < import uk.ac.ukc.iscream.core.*;
26 < import uk.ac.ukc.iscream.filter.*;
27 < import org.omg.CORBA.*;
28 < import org.omg.CosNaming.*;
9 < import org.omg.PortableServer.*;
25 > import uk.org.iscream.cms.util.*;
26 > import uk.org.iscream.cms.server.core.*;
27 > import uk.org.iscream.cms.server.componentmanager.*;
28 > import uk.org.iscream.cms.server.filter.*;
29  
30   /**
31   * A Filter Startup Class
32 + * A filter is an iscream component.
33   *
34   * @author  $Author$
35   * @version $Id$
36   */
37 < class FilterMain {
37 > public class FilterMain implements Component {
38  
39   //---FINAL ATTRIBUTES---
40  
# Line 25 | Line 45 | class FilterMain {
45      
46   //---STATIC METHODS---
47  
48 <    public static void main(String[] args) {
49 <        System.setProperty("org.omg.CORBA.ORBClass","jacorb.orb.ORB");
50 <        System.setProperty("org.omg.CORBA.ORBSingletonClass","jacorb.orb.ORBSingleton");
48 > //---CONSTRUCTORS---
49 >    
50 >    /**
51 >     * Constructs a Filter with the name given
52 >     *
53 >     * @param givenName the name
54 >     */
55 >    public FilterMain(String givenName) {
56 >        NAME = givenName;
57 >    }
58 >
59 > //---PUBLIC METHODS---
60 >
61 >    /**
62 >     * Starts the Filter component
63 >     */
64 >    public void start() throws ComponentStartException {
65 >        // get references to key objects
66 >        _logger = _refman.getLogger();
67          
68 <        // get our name from the command line
69 <        String ourName = "";
70 <        if (args.length == 1) {
71 <            ourName = args[0];
68 >        _logger.write(toString(), Logger.SYSINIT, "coming up");
69 >        
70 >        ConfigurationProxy cp = ConfigurationProxy.getInstance();
71 >        
72 >        // which input methods do we need to activate?
73 >        // default to activating them
74 >        boolean activateTCPReader = true;
75 >        boolean activateUDPReader = true;
76 >        boolean activateCORBAReader = true;
77 >        
78 >        // check for TCP Reader
79 >        try {
80 >            int tcp = Integer.parseInt(cp.getProperty("Filter." + FilterMain.NAME, "Filter.ActivateTCPReader"));
81 >            activateTCPReader = (tcp == 1);
82 >        } catch (PropertyNotFoundException e) {
83 >            activateTCPReader = false;
84 >        } catch (NumberFormatException e) {
85 >            activateTCPReader = false;
86          }
87 <        else {
88 <            usage();
87 >        // check for UDP Reader
88 >        try {
89 >            int udp = Integer.parseInt(cp.getProperty("Filter." + FilterMain.NAME, "Filter.ActivateUDPReader"));
90 >            activateUDPReader = (udp == 1);
91 >        } catch (PropertyNotFoundException e) {
92 >            activateUDPReader = false;
93 >        } catch (NumberFormatException e) {
94 >            activateUDPReader = false;
95          }
96 +        // check for CORBA Reader
97 +        try {
98 +            int corba = Integer.parseInt(cp.getProperty("Filter." + FilterMain.NAME, "Filter.ActivateCORBAReader"));
99 +            activateCORBAReader = (corba == 1);
100 +        } catch (PropertyNotFoundException e) {
101 +            activateCORBAReader = false;
102 +        } catch (NumberFormatException e) {
103 +            activateCORBAReader = false;
104 +        }
105          
106 <        // can't have a real toString() :)
107 <        String toString = "Filter{" + ourName + "}(" + REVISION.substring(11, REVISION.length() - 2) + ")";
106 >        // need to use the Queue later on
107 >        Queue queue;
108          
109 <        try {        
110 <            ORB orb = ORB.init(args, null);
111 <            
112 <            // something to hold objects
113 <            org.omg.CORBA.Object objRef = null;    
114 <            
115 <            // get the Root POA
116 <            objRef = orb.resolve_initial_references("RootPOA");
117 <            POA poa = POAHelper.narrow(objRef);
118 <            
119 <            // get a hook to the name service
120 <            objRef = orb.resolve_initial_references("NameService");
121 <            NamingContextExt ncRef = NamingContextExtHelper.narrow(objRef);
109 >        // there's little point starting a Queue and a FilterThread
110 >        // if nothing is going to be giving us any data
111 >        if(activateTCPReader || activateUDPReader || activateCORBAReader) {
112 >            // see if this Queue needs a size limit
113 >            try {
114 >                int queueSizeLimit = Integer.parseInt(cp.getProperty("Filter." + FilterMain.NAME, "Queue.SizeLimit"));
115 >                String queueRemoveAlgorithm = cp.getProperty("Filter." + FilterMain.NAME, "Queue.RemoveAlgorithm");
116 >                int algorithm = StringUtils.getStringPos(queueRemoveAlgorithm, Queue.algorithms);
117 >                if(algorithm != -1) {
118 >                    _logger.write(toString(), Logger.DEBUG, "Starting Queue with size limit of "+queueSizeLimit+", using remove algorithm "+queueRemoveAlgorithm);
119 >                    // we have valid values, so lets start it.
120 >                    queue = new Queue(queueSizeLimit, algorithm);
121 >                }
122 >                else {
123 >                    _logger.write(toString(), Logger.WARNING, "Bad Queue Algorithm configuration, not known: "+queueRemoveAlgorithm);
124 >                    // just don't activate a limit
125 >                    queue = new Queue();
126 >                }
127                  
128 <            // get a ref to the ConfigurationManager, Logger & the FilterManager
128 >            } catch (PropertyNotFoundException e) {
129 >                _logger.write(toString(), Logger.DEBUG, "Optional config not set: "+e);
130 >                // just don't activate a limit
131 >                queue = new Queue();
132 >            } catch (NumberFormatException e) {
133 >                _logger.write(toString(), Logger.WARNING, "Bad Queue SizeLimit configuration: "+e);
134 >                // just don't activate a limit
135 >                queue = new Queue();
136 >            }
137              
138 <            objRef = ncRef.resolve(ncRef.to_name("iscream.ConfigurationManager"));
139 <            ConfigurationManager configManager = ConfigurationManagerHelper.narrow(objRef);
140 <            
141 <            objRef = ncRef.resolve(ncRef.to_name("iscream.Logger"));
142 <            Logger logger = LoggerHelper.narrow(objRef);
143 <            
144 <            logger.write(toString, Logger.SYSINIT, "coming up");
145 <            
68 <            
69 <            // **** THIS SECTION WILL NEED CHANGING TO GET RELEVANT CONFIG
70 <            // **** Please ignore this block of code, it's just "copy/paste" :)
71 <            
72 <            // get the config
73 <            Configuration myConfig = configManager.getConfiguration(ourName);
74 <            
75 <            // read some config here
76 <            int UDPport = 0;
77 <            int TCPport = 0;
78 <            String parentFilterName = null;
79 <  
80 <            // did we?
81 <            if (myConfig == null) {
82 <                System.out.println("Failed: is it there?, can you read it?");
83 <                System.exit(1);
84 <            } else {
85 <              
86 <                // get the property
87 <                try {
88 <                    //QUERY HERE.... ???
89 <                    UDPport = new Integer(myConfig.getProperty("Filter.UDPlistenPort")).intValue();
90 <                    TCPport = new Integer(myConfig.getProperty("Filter.TCPlistenPort")).intValue();
91 <                    parentFilterName = myConfig.getProperty("Filter.parentFilter");
92 <                } catch (org.omg.CORBA.MARSHAL e) {
93 <                    System.out.println("Caught org.omg.CORBA.MARSHAL, must be a null we got back");
94 <                    //System.exit(1);
95 <                }
138 >            // startup a monitor on this queue
139 >            try {
140 >                // try to get the interval, if this fails, we won't start up the monitor
141 >                int queueMonitorInterval = Integer.parseInt(cp.getProperty("Filter." + FilterMain.NAME, "Queue.MonitorInterval"));
142 >                String queueName = NAME + " Filter";
143 >                queue.startMonitor(queueMonitorInterval*1000, queueName);
144 >            } catch (PropertyNotFoundException e) {
145 >                _logger.write(toString(), Logger.WARNING, "failed to find queue monitor config, disabling. " + e);
146              }
147              
148 <            logger.write(toString, Logger.SYSINIT, "configured");
149 <            
150 <            // **** END COMMENT
151 <            
102 <            // **** INITIAL FILTER MANAGER COMMUNICATIONS HERE
103 <            
104 <            // get a root (CHANGE to use FilterManager)
105 <            objRef = ncRef.resolve(ncRef.to_name("iscream.Filter." + parentFilterName));
106 <            Filter parentFilter = FilterHelper.narrow(objRef);
107 <
108 <            // SETUP our Servant
109 <            
110 <            // create the FilterServant
111 <            logger.write(toString, Logger.DEBUG, "firing servant with parent - " + parentFilterName);
112 <            FilterServant filterServant = new FilterServant(logger, parentFilter, ourName, new Integer(TCPport).toString() , new Integer(UDPport).toString());
113 <
114 <            // register ourselves
115 <
116 <            // and advertise it to the naming context
117 <            objRef = poa.servant_to_reference(filterServant);
118 <            ncRef.bind(ncRef.to_name("iscream.Filter."+ourName), objRef);
119 <
120 <            // **** END COMMENT
121 <            
122 <            // END SETUP
123 <            
124 <
125 <            /**************************************************************
126 <              Here would be an ideal place to start another thread to do
127 <              the listening part of the Filter. Ideally it should just be
128 <              created and then run(). It may be necessary to pass some of
129 <              the following parameters into the thread by the constructor.
130 <              
131 <                  Logger logger
132 <                      - a reference to a Logger object
133 <                  FilterManager filterManager
134 <                      - a reference to the system filter manager
135 <                  ConfigurationManager configManager
136 <                      - a reference to the system configuration manager
137 <                  Configuration myConfig
138 <                      - a reference to the configuration object for this
139 <                        filter instance
140 <                  String ourName
141 <                      - our "identifier" name
142 <            
143 <            **************************************************************/
144 <                                    
145 <            logger.write(toString, Logger.SYSINIT, "starting Filter UDP listener");
146 <            UDPReader udpReader = new UDPReader(UDPport, parentFilter, logger);
147 <            udpReader.start();
148 <            logger.write(toString, Logger.SYSINIT, "Filter UDP listener started");
149 <
150 <            logger.write(toString, Logger.SYSINIT, "starting Filter TCP listener");
151 <            TCPReader tcpReader = new TCPReader(logger, configManager, TCPport, parentFilter);
152 <            tcpReader.start();
153 <            logger.write(toString, Logger.SYSINIT, "Filter TCP listener started");
154 <
155 <            // TEST
156 <            //parentFilter.receiveXML("<?xml version=\"1.0\" encoding=\"ISO8859-1\"?><packet><test>This is just a debugging test, we ("+ourName+") are live on UDPport: "+UDPport+"</test></packet>");
157 <            
158 <            // start the POA off
159 <            poa.the_POAManager().activate();
160 <                        
161 <            logger.write(toString, Logger.SYSINIT, "started");
162 <            
163 <            // now we are running, we just need to serve
164 <            // so we ask the orb to block for us until it has finished
165 <            orb.run();
166 <            
167 <        } catch (Exception e) {
168 <            System.err.println("FILTER ERROR: " + e);
169 <            e.printStackTrace(System.out);
148 >            // Start a filter thread
149 >            _logger.write(toString(), Logger.SYSINIT, "starting Filter Thread / Queue consumer");
150 >            FilterThread filterThread = new FilterThread(queue);
151 >            filterThread.start();
152          }
153 +        else {
154 +            // it's pointless carrying on really...
155 +            throw new ComponentStartException("Can't start Filter without any inbound data feeds");            
156 +        }
157 +        
158 +        // the corba listener needs these to be set, so lets
159 +        // make them something obviously invalid initially
160 +        int TCPListenPort = -1;
161 +        int UDPListenPort = -1;
162 +        
163 +        // TCP Reader start (for heartbeats)
164 +        if(activateTCPReader) {
165 +            try {
166 +                // get the port number from the configuration
167 +                TCPListenPort = Integer.parseInt(cp.getProperty("Filter." + FilterMain.NAME, "Filter.TCPListenPort"));
168 +                // start the TCPReader
169 +                _logger.write(toString(), Logger.SYSINIT, "starting Filter TCP listener");
170 +                TCPReader tcpReader = new TCPReader(TCPListenPort, queue);
171 +                tcpReader.start();
172 +            } catch (PropertyNotFoundException e) {
173 +                _logger.write(toString(), Logger.WARNING, "Unable to start TCPReader due to missing configuration: " + e);
174 +            } catch (NumberFormatException e) {
175 +                _logger.write(toString(), Logger.WARNING, "Unable to start TCPReader due to invalid configuration: " + e);
176 +            }
177 +        }
178 +        
179 +        // UDP Reader start (for inbound host data)
180 +        if(activateUDPReader) {
181 +            try {
182 +                // get the port number from the configuration
183 +                UDPListenPort = Integer.parseInt(cp.getProperty("Filter." + FilterMain.NAME, "Filter.UDPListenPort"));
184 +                // start the UDPReader
185 +                _logger.write(toString(), Logger.SYSINIT, "starting Filter UDP listener");
186 +                UDPReader udpReader = new UDPReader(UDPListenPort, queue);
187 +                udpReader.start();
188 +            } catch (PropertyNotFoundException e) {
189 +                _logger.write(toString(), Logger.WARNING, "Unable to start UDPReader due to missing configuration: " + e);
190 +            } catch (NumberFormatException e) {
191 +                _logger.write(toString(), Logger.WARNING, "Unable to start UDPReader due to invalid configuration: " + e);
192 +            }
193 +        }
194 +        
195 +        // FilterServant start (for inbound child filter data)
196 +        if(activateCORBAReader) {
197 +            // start the FilterServant
198 +            _logger.write(toString(), Logger.SYSINIT, "starting Servant to listen for downstream filters");
199 +            FilterServant filterServant = new FilterServant(queue);
200 +            _refman.bindToOrb(filterServant, "iscream.Filter\\." + FilterMain.NAME);
201 +        }
202 +        
203 +        // FilterInfoServant start (to provide filter information to the server)
204 +        _logger.write(toString(), Logger.SYSINIT, "starting Servant to provide filter information");
205 +        FilterInfoServant filterInfoServant = new FilterInfoServant(TCPListenPort, UDPListenPort);
206 +        _refman.bindToOrb(filterInfoServant, "iscream.FilterInfo\\." + FilterMain.NAME);
207 +        
208 +        _logger.write(toString(), Logger.SYSINIT, "started");
209      }
210 <
211 <    /**
212 <     * A simple method to print the usage of this class.
213 <     * It never returns, but instead exits to the system
214 <     * with a value 1, to indicate the system did not start
215 <     * properly.
210 >    
211 >    /**
212 >     * Does a dependency check. Used mainly at startup to
213 >     * see if the required dependencies (components) are up
214 >     * and running.
215 >     *
216 >     * @return a boolean value, true if the depdencies are satisfied
217       */
218 <    public static void usage() {
219 <        System.out.println("USAGE: java FilterMain <name>");
220 <        System.out.println("WHERE <name>:");
221 <        System.out.println("      The unique identifier for the Filter in the system.");
222 <        System.exit(1);
218 >    public boolean depCheck() {
219 >        try {
220 >            org.omg.CORBA.Object obj;
221 >            // first check the ConfigurationManager is alive
222 >            obj = _refman.getCORBARef("iscream.ConfigurationManager");
223 >            // then suss out our parent filter
224 >            ConfigurationProxy cp = ConfigurationProxy.getInstance();
225 >            String parentFilterName = cp.getProperty("Filter." + FilterMain.NAME, "Filter.parentFilter");
226 >            // finally check the parent filter is alive
227 >            obj = _refman.getCORBARef("iscream.Filter\\." + parentFilterName);
228 >        } catch(ComponentCORBAException e) {
229 >            System.err.println(toString() + ": Dependency Failure: "+e);
230 >            return false;
231 >        } catch(PropertyNotFoundException e) {
232 >            System.err.println(toString() + ": Unable to obtain configuration: "+e);
233 >            return false;
234 >        }
235 >        // dependency check suceeded
236 >        return true;
237      }
238 +    
239 +    /**
240 +     * Overrides the {@link java.lang.Object#toString() Object.toString()}
241 +     * method to provide clean logging (every class should have this).
242 +     *
243 +     * This uses the uk.org.iscream.cms.util.NameFormat class
244 +     * to format the toString()
245 +     *
246 +     * @return the name of this class and its CVS revision
247 +     */
248 +    public String toString() {
249 +        return FormatName.getName(
250 +            NAME,
251 +            getClass().getName(),
252 +            REVISION);
253 +    }
254  
186 //---CONSTRUCTORS---
187
188 //---PUBLIC METHODS---
189
255   //---PRIVATE METHODS---
256  
257   //---ACCESSOR/MUTATOR METHODS---
258  
259   //---ATTRIBUTES---
260  
261 +    /**
262 +     * This holds a reference to the
263 +     * system logger that is being used.
264 +     */
265 +    private Logger _logger;
266 +
267 +    /**
268 +     * A reference to the reference manager in use
269 +     */
270 +    private ReferenceManager _refman = ReferenceManager.getInstance();
271 +
272   //---STATIC ATTRIBUTES---
273  
274 < }            
274 >    /**
275 >     * The friendly name for this component, used by
276 >     * all related classes.
277 >     * This is set from the configuration.
278 >     */
279 >    public static String NAME;
280 >
281 > }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines