server/core/ConfigurationServant.java

//---PACKAGE DECLARATION---
package uk.ac.ukc.iscream.core;

//---IMPORTS---
import uk.ac.ukc.iscream.util.*;
import uk.ac.ukc.iscream.componentmanager.*;
import java.util.Properties;
import java.util.Date;
import java.text.DateFormat;

/**
 * An implementation of the Configuration IDL
 * This class allows i-scream modules to read and even
 * set their configuration from a central location.
 *
 * When classes want their configuration, they contact
 * the ConfigurationManager, which will locate their config,
 * open it and pass it to a Configuration object which is
 * then passed back to the calling class.
 *
 * Essentially this class behaves in a similar fashion
 * to the java.util.Properties class.
 *
 * @author  $Author: ajm4 $
 * @version $Id: ConfigurationServant.java,v 1.14 2000/12/12 18:26:52 ajm4 Exp $
 */
class ConfigurationServant extends ConfigurationPOA {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.14 $";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

    /**
     * Creates a new ConfigurationServant taking a hook
     * to a Properties object containing the configuration.
     *
     * @param properties a Properties object that contains the full properties for this configuration
     * @param fileList the list of config files used to build this configuration
     * @param lastModified the most recent last modified value for the file list
     * @param logRef a reference to the logger system
     */
    ConfigurationServant(Properties properties, String fileList, long lastModified) {
        // assign local variables
        _properties = properties;
        _lastModified = lastModified;
        _fileList = fileList;
        _logger.write(toString(), Logger.SYSINIT, "created");
        String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.MEDIUM).format(new Date(getLastModified()));
        _logger.write(toString(), Logger.SYSMSG, "last modified - " + date);
        _logger.write(toString(), Logger.DEBUG, "file list - " + _fileList);
    }
 
//---PUBLIC METHODS---

    /**
     * A wrapper for java.util.Properties.getProperty
     * When given a key it returns the value of that key
     * ie, key = value
     *
     * @param key the key the value of which is wanted
     */
    public String getProperty(String key) {
        return _properties.getProperty(key); 
    }
    
    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * This uses the uk.ac.ukc.iscream.util.FormatName class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return FormatName.getName(
            _name,
            getClass().getName(),
            REVISION);
    }

//---PRIVATE METHODS---

    /**
     * Overridden for debugging purposes
     * to see when an instance of this class
     * is destroyed
     */
    protected void finalize() throws Throwable {
        _logger.write(this.toString(), Logger.DEBUG, "finalized");
    }

//---ACCESSOR/MUTATOR METHODS---

    /**
     * Returns the date stamp of the configuration file
     * this object is using.
     *
     * @return the last modified time for the file
     */
    public long getLastModified() {
        return _lastModified;
    }

    /**
     * Returns the list of files used to build the Properties
     * this object is using.
     *
     * @return the list of files
     */
    public String getFileList() {
        return _fileList;
    }

//---ATTRIBUTES---

    /**
     * The properties object that this class provides a CORBA interface to
     */
    private Properties _properties = new Properties();

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = ReferenceManager.getInstance().getLogger();
    
    /**
     * This is the friendly identifier of the
     * component this class is running in.
     * eg, a Filter may be called "filter1",
     * If this class does not have an owning
     * component,  a name from the configuration
     * can be placed here.  This name could also
     * be changed to null for utility classes.
     */
    private String _name = Core.NAME;

    /**
     * The date stamp of the configuration file
     * this object is using
     */
    private long _lastModified;
    
    /**
     * The list of files that were used to build this configuration
     */
    private String _fileList;
    
//---STATIC ATTRIBUTES---

}
Revision:	1.15
Committed:	Thu Jan 18 23:10:44 2001 UTC (23 years, 4 months ago) by tdb
Branch:	MAIN
Changes since 1.14:	+3 -2 lines
Log Message:	Changes to reflect move of Component, ComponentStartException, and the ReferenceManager from util to componentmanager.
#	User	Rev	Content
1	tdb	1.11	//---PACKAGE DECLARATION---
2	ajm	1.13	package uk.ac.ukc.iscream.core;
3	tdb	1.11
4			//---IMPORTS---
5	ajm	1.14	import uk.ac.ukc.iscream.util.*;
6	tdb	1.15	import uk.ac.ukc.iscream.componentmanager.*;
7	ajm	1.14	import java.util.Properties;
8			import java.util.Date;
9	tdb	1.11	import java.text.DateFormat;
10
11			/**
12			* An implementation of the Configuration IDL
13			* This class allows i-scream modules to read and even
14			* set their configuration from a central location.
15			*
16			* When classes want their configuration, they contact
17	ajm	1.12	* the ConfigurationManager, which will locate their config,
18	tdb	1.11	* open it and pass it to a Configuration object which is
19			* then passed back to the calling class.
20			*
21			* Essentially this class behaves in a similar fashion
22			* to the java.util.Properties class.
23			*
24	ajm	1.13	* @author $Author: ajm4 $
25	tdb	1.15	* @version $Id: ConfigurationServant.java,v 1.14 2000/12/12 18:26:52 ajm4 Exp $
26	tdb	1.11	*/
27			class ConfigurationServant extends ConfigurationPOA {
28
29			//---FINAL ATTRIBUTES---
30
31			/**
32			* The current CVS revision of this class
33			*/
34	tdb	1.15	public final String REVISION = "$Revision: 1.14 $";
35	tdb	1.11
36			//---STATIC METHODS---
37
38			//---CONSTRUCTORS---
39
40			/**
41			* Creates a new ConfigurationServant taking a hook
42	ajm	1.12	* to a Properties object containing the configuration.
43	tdb	1.11	*
44	ajm	1.12	* @param properties a Properties object that contains the full properties for this configuration
45			* @param fileList the list of config files used to build this configuration
46			* @param lastModified the most recent last modified value for the file list
47			* @param logRef a reference to the logger system
48	tdb	1.11	*/
49	ajm	1.14	ConfigurationServant(Properties properties, String fileList, long lastModified) {
50	ajm	1.12	// assign local variables
51	tdb	1.11	_properties = properties;
52			_lastModified = lastModified;
53			_fileList = fileList;
54	ajm	1.14	_logger.write(toString(), Logger.SYSINIT, "created");
55	tdb	1.11	String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.MEDIUM).format(new Date(getLastModified()));
56	ajm	1.14	_logger.write(toString(), Logger.SYSMSG, "last modified - " + date);
57			_logger.write(toString(), Logger.DEBUG, "file list - " + _fileList);
58	tdb	1.11	}
59
60			//---PUBLIC METHODS---
61
62			/**
63			* A wrapper for java.util.Properties.getProperty
64			* When given a key it returns the value of that key
65			* ie, key = value
66			*
67			* @param key the key the value of which is wanted
68			*/
69			public String getProperty(String key) {
70			return _properties.getProperty(key);
71			}
72
73			/**
74			* Overrides the {@link java.lang.Object#toString() Object.toString()}
75			* method to provide clean logging (every class should have this).
76			*
77	ajm	1.14	* This uses the uk.ac.ukc.iscream.util.FormatName class
78			* to format the toString()
79			*
80	tdb	1.11	* @return the name of this class and its CVS revision
81			*/
82			public String toString() {
83	ajm	1.14	return FormatName.getName(
84			_name,
85			getClass().getName(),
86			REVISION);
87	tdb	1.11	}
88
89			//---PRIVATE METHODS---
90
91	ajm	1.12	/**
92			* Overridden for debugging purposes
93			* to see when an instance of this class
94			* is destroyed
95			*/
96	tdb	1.11	protected void finalize() throws Throwable {
97	ajm	1.14	_logger.write(this.toString(), Logger.DEBUG, "finalized");
98	tdb	1.11	}
99
100			//---ACCESSOR/MUTATOR METHODS---
101
102			/**
103			* Returns the date stamp of the configuration file
104			* this object is using.
105			*
106			* @return the last modified time for the file
107			*/
108			public long getLastModified() {
109			return _lastModified;
110			}
111
112	ajm	1.12	/**
113			* Returns the list of files used to build the Properties
114			* this object is using.
115			*
116			* @return the list of files
117			*/
118	tdb	1.11	public String getFileList() {
119			return _fileList;
120			}
121
122			//---ATTRIBUTES---
123
124			/**
125			* The properties object that this class provides a CORBA interface to
126			*/
127			private Properties _properties = new Properties();
128
129			/**
130	ajm	1.14	* This holds a reference to the
131			* system logger that is being used.
132	tdb	1.11	*/
133	ajm	1.14	private Logger _logger = ReferenceManager.getInstance().getLogger();
134
135			/**
136			* This is the friendly identifier of the
137			* component this class is running in.
138			* eg, a Filter may be called "filter1",
139			* If this class does not have an owning
140			* component, a name from the configuration
141			* can be placed here. This name could also
142			* be changed to null for utility classes.
143			*/
144			private String _name = Core.NAME;
145	tdb	1.11
146			/**
147			* The date stamp of the configuration file
148			* this object is using
149			*/
150			private long _lastModified;
151	ajm	1.12
152			/**
153			* The list of files that were used to build this configuration
154			*/
155	tdb	1.11	private String _fileList;
156
157			//---STATIC ATTRIBUTES---
158
159			}