ViewVC Help

View File | Revision Log | Show Annotations | Revision Graph | Root Listing

root/i-scream/projects/cms/source/server/uk/org/iscream/cms/server/core/ConfigurationManagerServant.java

Comparing projects/cms/source/server/uk/org/iscream/cms/server/core/ConfigurationManagerServant.java (file contents):
Revision 1.6 by ajm, Tue Dec 12 18:26:52 2000 UTC vs.
Revision 1.23 by tdb, Sat May 18 18:16:01 2002 UTC

#	Line 1 | Line 1
1	+	/*
2	+	* i-scream central monitoring system
3	+	* Copyright (C) 2000-2002 i-scream
4	+	*
5	+	* This program is free software; you can redistribute it and/or
6	+	* modify it under the terms of the GNU General Public License
7	+	* as published by the Free Software Foundation; either version 2
8	+	* of the License, or (at your option) any later version.
9	+	*
10	+	* This program is distributed in the hope that it will be useful,
11	+	* but WITHOUT ANY WARRANTY; without even the implied warranty of
12	+	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13	+	* GNU General Public License for more details.
14	+	*
15	+	* You should have received a copy of the GNU General Public License
16	+	* along with this program; if not, write to the Free Software
17	+	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18	+	*/
19	+
20		//---PACKAGE DECLARATION---
21	<	package uk.ac.ukc.iscream.core;
21	>	package uk.org.iscream.cms.server.core;
22
23		//---IMPORTS---
24	<	import uk.ac.ukc.iscream.util.*;
24	>	import uk.org.iscream.cms.server.util.*;
25	>	import uk.org.iscream.cms.server.componentmanager.*;
26	>	import java.net.InetAddress;
27	>	import java.net.UnknownHostException;
28		import java.util.*;
29		import java.io.*;
30
#	Line 17 | Line 39 | import java.io.*;
39		*
40		* It also relies on the System.properties to set internal values.
41		*
20	–	* ###
21	–	* A point to note is that this class does NOT yet manage
22	–	* created configurations which may cause memory problems!
23	–	* ###
24	–	*
42		* @author  $Author$
43		* @version $Id$
44		*/
#	Line 44 | Line 61 | class ConfigurationManagerServant extends Configuratio
61		*/
62		ConfigurationManagerServant() {
63		// assign some local variables
64	<	_configPath = System.getProperty("uk.ac.ukc.iscream.ConfigurationLocation");
65	<	_systemConfigFile = System.getProperty("uk.ac.ukc.iscream.SystemConfigurationFile");
64	>	_configPath = System.getProperty("uk.org.iscream.cms.server.ConfigurationLocation");
65	>	_systemConfigFile = System.getProperty("uk.org.iscream.cms.server.SystemConfigurationFile");
66
67		// load the system config
68		loadSystemConfig();
#	Line 79 | Line 96 | class ConfigurationManagerServant extends Configuratio
96		*/
97		public Configuration getConfiguration(String source) {
98		_logger.write(toString(), Logger.SYSMSG, "got request for " + source);
99	<	Configuration config = null;
99	>
100
101		// check to see if we need to reload the system config
102		// because it has changed
#	Line 88 | Line 105 | class ConfigurationManagerServant extends Configuratio
105		loadSystemConfig();
106		}
107
108	<	// we look for this entry in the systemConfig
109	<	String configFile = _systemConfig.getProperty("config." + source);
110	<	_logger.write(toString(), Logger.DEBUG, "looking for config tree in - " + configFile);
111	<
112	<	// if there is an entry
113	<	if (configFile != null) {
108	>	// search config for group membership
109	>	// and obain a list of groups by name
110	>	LinkedList nameGroups = getGroupMembership(source);
111	>	// add the hosts individual config to the start of the list
112	>	nameGroups.addFirst(source);
113	>
114	>	// this list will be used to compile the groupings
115	>	LinkedList groups = new LinkedList();
116	>
117	>	// if we are dealing with a Host.<hostname> request, then we also
118	>	// want to look for ip address details, as configuration entries may relate to it
119	>	// if we can't resolve it, we don't look.
120	>	LinkedList ipGroups = null;
121	>	if (source.startsWith("Host.")) {
122	>	// hostname is after Host.
123	>	String hostname = source.substring(5);
124		try {
125	<	// get the file list of includes etc + the system config
126	<	String fileList = _systemConfigFile + ";" + getIncludedFiles(configFile, "");
127	<	_logger.write(toString(), Logger.DEBUG, "config tree - " + fileList);
128	<
129	<	// build the properites here from the filelist....
130	<	StringTokenizer st = new StringTokenizer(fileList, ";");
131	<
132	<	// some holders for variables
133	<	File currentFile;
134	<	long lastModified, newLastModified;
135	<	Properties properties, prevProperties;
136	<
110	<	// the root of all configurations will be the system config
111	<	// so we need to open the properties of that
112	<	Properties defaultProperties = new Properties();
113	<	currentFile = new File(_configPath, _systemConfigFile);
114	<	lastModified = currentFile.lastModified();
115	<	defaultProperties.load(new FileInputStream(currentFile));
116	<
117	<	// This loop then iterates over the file list
118	<	// creates the properties to be passed to the
119	<	// Configuration constructor
120	<	do {
121	<	properties = new Properties(defaultProperties);
122	<	currentFile = new File(_configPath, st.nextToken());
123	<	newLastModified = currentFile.lastModified();
124	<	if (newLastModified > lastModified) {
125	<	lastModified = newLastModified;
126	<	}
127	<	properties.load(new FileInputStream(currentFile));
128	<	defaultProperties = properties;
129	<	} while (st.hasMoreTokens());
125	>	String ip = "Host." + InetAddress.getByName(hostname).getHostAddress();
126	>	ipGroups = getGroupMembership(ip);
127	>	ipGroups.addFirst(ip);
128	>	// add to our list of groups
129	>	groups.addAll(ipGroups);
130	>	} catch (UnknownHostException e) {
131	>	_logger.write(toString(), Logger.ERROR, "could not resolve hostname - " + hostname);
132	>	}
133	>	}
134	>
135	>	// add the rest of the groups to the end
136	>	groups.addAll(nameGroups);
137
138	<	// this creates the configuration, all nice, ready to be returned
139	<	ConfigurationServant ref = new ConfigurationServant(properties, fileList, lastModified);
140	<	org.omg.CORBA.Object objRef = _refman.getRootPOA().servant_to_reference(ref);
141	<	config = ConfigurationHelper.narrow(objRef);
142	<
143	<	} catch (Exception e) {
144	<	// not sure what to do here
145	<	// so we just log the error
146	<	_logger.write(toString(), Logger.ERROR, "ERROR - " + e.getMessage());
138	>	Iterator i = groups.iterator();
139	>	String fileList = "";
140	>	while (i.hasNext()) {
141	>	String groupName = (String) i.next();
142	>	_logger.write(toString(), Logger.DEBUG, "looking for config entry for - " + groupName);
143	>	// we look for this entry in the systemConfig
144	>	String configFile = _systemConfig.getProperty("config." + groupName);
145	>	// if there is a config entry then
146	>	if (configFile != null) {
147	>	_logger.write(toString(), Logger.DEBUG, "looking for config tree in - " + configFile);
148	>
149	>	// get the file list of includes etc + the system config
150	>	String groupFileList = null;
151	>	try {
152	>	groupFileList = getIncludedFiles(configFile, "") + ";";
153	>	} catch (Exception e) {
154	>	// not sure what to do here
155	>	// so we just log the error
156	>	_logger.write(toString(), Logger.ERROR, "ERROR - " + e);
157	>	}
158	>	if (groupFileList != null) {
159	>	fileList += groupFileList;
160	>	}
161	>	} else {
162	>	_logger.write(toString(), Logger.DEBUG, "no config entry for - " + groupName);
163		}
141	–
142	–	// if there isn't an entry for the requested config
143	–	} else {
144	–	_logger.write(toString(), Logger.DEBUG, "no configured config, returning " + _systemConfigFile);
145	–	config = _systemConfig;
164		}
165	+	// add the system config as the final check
166	+	fileList = _systemConfigFile + ";" + fileList;
167	+	_logger.write(toString(), Logger.DEBUG, "config tree - " + fileList);
168
169	+	// build the configuration
170	+	Configuration config = buildConfiguration(fileList);
171	+
172		// if this is null at this point, then there will have been an error
173		return config;
174		}
#	Line 179 | Line 203 | class ConfigurationManagerServant extends Configuratio
203		* Overrides the {@link java.lang.Object#toString() Object.toString()}
204		* method to provide clean logging (every class should have this).
205		*
206	<	* This uses the uk.ac.ukc.iscream.util.FormatName class
206	>	* This uses the uk.org.iscream.cms.server.util.FormatName class
207		* to format the toString()
208		*
209		* @return the name of this class and its CVS revision
#	Line 270 | Line 294 | class ConfigurationManagerServant extends Configuratio
294		try {
295		// create the properties for the configuration
296		File systemConfigFile = new File(_configPath, _systemConfigFile);
297	<	Properties systemConfigHolder = new Properties();
298	<	systemConfigHolder.load(new FileInputStream(systemConfigFile));
299	<
297	>	_systemConfigHolder = new Properties();
298	>	_systemConfigHolder.load(new FileInputStream(systemConfigFile));
299	>
300		// create the servant
301	<	ConfigurationServant ref = new ConfigurationServant(systemConfigHolder, _systemConfigFile, systemConfigFile.lastModified());
301	>	ConfigurationServant ref = new ConfigurationServant(_systemConfigHolder, _systemConfigFile, systemConfigFile.lastModified());
302		org.omg.CORBA.Object objRef = _refman.getRootPOA().servant_to_reference(ref);
303
304		// narrow it to a Configuration
#	Line 285 | Line 309 | class ConfigurationManagerServant extends Configuratio
309		}
310		}
311
312	+	/**
313	+	* Parses the system configuration file
314	+	* for group membership entries.
315	+	*
316	+	* It looks for all entries of group.<name>
317	+	* which contain the given source name
318	+	*
319	+	* @param source the source to find membership for
320	+	*
321	+	* @return the list of groups that this source is a member of
322	+	*/
323	+	private LinkedList getGroupMembership(String source) {
324	+	_logger.write(toString(), Logger.DEBUG, "searching groups for - " + source);
325	+	LinkedList groupMembership = new LinkedList();
326	+	Iterator i = new TreeSet(_systemConfigHolder.keySet()).iterator();
327	+	while(i.hasNext()) {
328	+	String key = (String) i.next();
329	+	// look for a key that's a group entry
330	+	if (key.startsWith("group.")) {
331	+	// get the list of hosts in the group
332	+	String group = _systemConfig.getProperty(key);
333	+	if(groupMatch(source, group)) {
334	+	groupMembership.add(key.substring(6));
335	+	_logger.write(toString(), Logger.DEBUG, "group match found for - " + source + " in group - " + key);
336	+	}
337	+	}
338	+	}
339	+	return groupMembership;
340	+	}
341	+
342	+	/**
343	+	* Checks that a given source is matched within the
344	+	* given list of hosts. For example:<br>
345	+	* <br>
346	+	* Given "stue5de.ukc.ac.uk"<br>
347	+	* And   "raptor.ukc.ac.uk;stue*.ukc.ac.uk<br>
348	+	* <br>
349	+	* This method would return true as there is a match.
350	+	*
351	+	* This method will also match if the source is exactly
352	+	* matched within the group of hosts (ie. no wildcard).
353	+	*
354	+	* @param source the string to look for
355	+	* @param group the group to search for a match
356	+	*
357	+	* @return if there is a match
358	+	*/
359	+	public static boolean groupMatch(String source, String group) {
360	+	StringTokenizer st = new StringTokenizer(group, ";");
361	+	// go through all the hosts in the group
362	+	while (st.hasMoreTokens()) {
363	+	String host = st.nextToken();
364	+	if(StringUtils.wildcardMatch(source, host)) {
365	+	return true;
366	+	}
367	+	}
368	+	// not had a match
369	+	return false;
370	+	}
371	+
372	+	/**
373	+	* Build the properties as a Configuration to be
374	+	* returned to the caller
375	+	*
376	+	* @param fileList the list of files to build the configuration from
377	+	*
378	+	* @return the built Configuration
379	+	*/
380	+	private Configuration buildConfiguration(String fileList) {
381	+	Configuration config = null;
382	+
383	+	// if there is an entry
384	+	if (!fileList.equals("")) {
385	+	try {
386	+
387	+	// build the properites here from the filelist....
388	+	StringTokenizer st = new StringTokenizer(fileList, ";");
389	+
390	+	// some holders for variables
391	+	File currentFile;
392	+	long lastModified = 0, newLastModified = 0;
393	+	Properties properties = null, prevProperties = null;
394	+
395	+	// the root of all configurations will be the system config
396	+	// so we need to open the properties of that
397	+	Properties defaultProperties = new Properties();
398	+
399	+	// This loop then iterates over the file list
400	+	// creates the properties to be passed to the
401	+	// Configuration constructor
402	+	while (st.hasMoreTokens()) {
403	+	properties = new Properties(defaultProperties);
404	+	currentFile = new File(_configPath, st.nextToken());
405	+	newLastModified = currentFile.lastModified();
406	+	if (newLastModified > lastModified) {
407	+	lastModified = newLastModified;
408	+	}
409	+	properties.load(new FileInputStream(currentFile));
410	+	defaultProperties = properties;
411	+	}
412	+
413	+	// this creates the configuration, all nice, ready to be returned
414	+	ConfigurationServant ref = new ConfigurationServant(properties, fileList, lastModified);
415	+	org.omg.CORBA.Object objRef = _refman.getRootPOA().servant_to_reference(ref);
416	+	config = ConfigurationHelper.narrow(objRef);
417	+	_logger.write(toString(), Logger.DEBUG, "returning built configuration");
418	+	} catch (Exception e) {
419	+	// not sure what to do here
420	+	// so we just log the error
421	+	_logger.write(toString(), Logger.ERROR, "ERROR - " + e);
422	+	}
423	+
424	+	// if there isn't an entry for the requested config
425	+	} else {
426	+	_logger.write(toString(), Logger.DEBUG, "no configured config, returning " + _systemConfigFile);
427	+	config = _systemConfig;
428	+	}
429	+	return config;
430	+	}
431	+
432		//---ACCESSOR/MUTATOR METHODS---
433
434		//---ATTRIBUTES---
#	Line 325 | Line 469 | class ConfigurationManagerServant extends Configuratio
469		* An instance of the system config
470		*/
471		private Configuration _systemConfig;
472	+
473	+	/**
474	+	* The system config file represented by a
475	+	* properties object.
476	+	*/
477	+	private Properties _systemConfigHolder;
478
479		//---STATIC ATTRIBUTES---
480

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines