server/componentmanager/ConfigurationCache.java

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.server.componentmanager;

//---IMPORTS---
import uk.org.iscream.cms.server.core.*;
import java.util.*;

/**
 * ConfigurationCache class
 * This is essentially a wrapper and cache for
 * Configuration CORBA objects.  The ConfigurationProxy creates an instance
 * of this class for every Configuration that is requested.  This class then
 * hold the reference to the configuration, but also maintains a cache where
 * the ConfigurationProxy can store cached property values to safe on CORBA
 * requests.
 *
 * @author  $Author: ajm4 $
 * @version $Id: ConfigurationCache.java,v 1.4 2001/03/26 01:39:41 ajm4 Exp $
 */
public class ConfigurationCache {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---
    
    /**
     * Construct a ConfigurationCache
     *
     * @param config a reference to the CORBA Configuration object this cache will hold
     * @param propertyCache a hashMap to hold cached properties
     */
    public ConfigurationCache(Configuration config, HashMap propertyCache) {
        _propertyCache = propertyCache;
        _config = config;
    }

//---PUBLIC METHODS---

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---
    
    /**
     * Obtins the hash containing cached
     * configuration property values.
     *
     * @return the property cache
     */
    public HashMap getPropertyCache() {
        return _propertyCache;
    }
    
    /**
     * Obtains the reference to the
     * CORBA configuration object this
     * cache holds.
     *
     * @return the configuration object
     */
    public Configuration getConfig() {
        return _config;
    }

    /**
     * Sets this cache to hold a new CORBA
     * Configuration object.
     *
     * @param config the new CORBA Configuration object
     */
    public void setConfig(Configuration config) {
        _config = config;
    }

    /**
     * Sets this cache to hold a new property
     * cache.
     *
     * @param propertyCache the new hash map to containing a property cache
     */
    public void setPropertyCache(HashMap propertyCache) {
        _propertyCache = propertyCache;
    }

//---ATTRIBUTES---

    /**
     * A hash that contains cached property values
     */
    private HashMap _propertyCache;
    
    /**
     * The Configuration this configuration cache looks after
     */
    private Configuration _config;

//---STATIC ATTRIBUTES---

}
Revision:	1.5
Committed:	Tue May 29 17:02:34 2001 UTC (23 years ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PIRCBOT
Changes since 1.4:	+5 -5 lines
Log Message:	Major change in the java package naming. This has been held off for some time now, but it really needed doing. The future packaging of all i-scream products will be; uk.org.iscream.<product>.<subpart>.* In the case of the central monitoring system server this will be; uk.org.iscream.cms.server.* The whole server has been changed to follow this structure, and tested to a smallish extent. Further changes in other parts of the CMS will follow.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.org.iscream.cms.server.componentmanager;
3
4	//---IMPORTS---
5	import uk.org.iscream.cms.server.core.*;
6	import java.util.*;
7
8	/**
9	* ConfigurationCache class
10	* This is essentially a wrapper and cache for
11	* Configuration CORBA objects. The ConfigurationProxy creates an instance
12	* of this class for every Configuration that is requested. This class then
13	* hold the reference to the configuration, but also maintains a cache where
14	* the ConfigurationProxy can store cached property values to safe on CORBA
15	* requests.
16	*
17	* @author $Author: ajm4 $
18	* @version $Id: ConfigurationCache.java,v 1.4 2001/03/26 01:39:41 ajm4 Exp $
19	*/
20	public class ConfigurationCache {
21
22	//---FINAL ATTRIBUTES---
23
24	/**
25	* The current CVS revision of this class
26	*/
27	public static final String REVISION = "$Revision: 1.4 $";
28
29	//---STATIC METHODS---
30
31	//---CONSTRUCTORS---
32
33	/**
34	* Construct a ConfigurationCache
35	*
36	* @param config a reference to the CORBA Configuration object this cache will hold
37	* @param propertyCache a hashMap to hold cached properties
38	*/
39	public ConfigurationCache(Configuration config, HashMap propertyCache) {
40	_propertyCache = propertyCache;
41	_config = config;
42	}
43
44	//---PUBLIC METHODS---
45
46	//---PRIVATE METHODS---
47
48	//---ACCESSOR/MUTATOR METHODS---
49
50	/**
51	* Obtins the hash containing cached
52	* configuration property values.
53	*
54	* @return the property cache
55	*/
56	public HashMap getPropertyCache() {
57	return _propertyCache;
58	}
59
60	/**
61	* Obtains the reference to the
62	* CORBA configuration object this
63	* cache holds.
64	*
65	* @return the configuration object
66	*/
67	public Configuration getConfig() {
68	return _config;
69	}
70
71	/**
72	* Sets this cache to hold a new CORBA
73	* Configuration object.
74	*
75	* @param config the new CORBA Configuration object
76	*/
77	public void setConfig(Configuration config) {
78	_config = config;
79	}
80
81	/**
82	* Sets this cache to hold a new property
83	* cache.
84	*
85	* @param propertyCache the new hash map to containing a property cache
86	*/
87	public void setPropertyCache(HashMap propertyCache) {
88	_propertyCache = propertyCache;
89	}
90
91	//---ATTRIBUTES---
92
93	/**
94	* A hash that contains cached property values
95	*/
96	private HashMap _propertyCache;
97
98	/**
99	* The Configuration this configuration cache looks after
100	*/
101	private Configuration _config;
102
103	//---STATIC ATTRIBUTES---
104
105	}