View Javadoc
1 /* ====================================================================
2 * License:
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * 3. The end-user documentation included with the redistribution,
17 * if any, must include the following acknowledgment:
18 * "This product includes software developed by
19 * Robert Half International (http://www.rhi.com/)."
20 * Alternately, this acknowledgment may appear in the software itself,
21 * if and wherever such third-party acknowledgments normally appear.
22 *
23 * 4. The names "Parc", "RHI", and "Robert Half International" must
24 * not be used to endorse or promote products derived from this
25 * software without prior written permission. For written
26 * permission, please contact pete.mckinstry@rhi.com.
27 *
28 * 5. Products derived from this software may not be called "PARC",
29 * nor may "PARC" appear in their name, without prior written
30 * permission of Robert Half International.
31 *
32 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
33 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
35 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
36 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
38 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
39 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
40 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
41 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
42 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * SUCH DAMAGE.
44 * ====================================================================
45 *
46 */
47 package com.rhi.architecture.config;
48
49 import com.rhi.architecture.resource.Resource;
50
51 import java.util.Properties;
52
53 /***
54 * Provide access to the application configuration information for
55 * any calling class.
56 *
57 * @author Pete McKinstry
58 * @copyright 2002, Robert Half Int'l., Inc. All rights reserved.
59 *
60 * @since 1.0
61 */
62 public class ConfigFacility implements Resource {
63
64 /***
65 * The key used by the ResourceContext to look for & store the configuration
66 * facility.
67 */
68 public static final String KEY = "Resource.ConfigFacility";
69
70 // thread safe
71 private static Object lock = new Object();
72
73 // configuration information
74 private Properties properties;
75
76 /***
77 * Default Constructor
78 *
79 * @since 1.0
80 */
81 public ConfigFacility() {
82 super();
83 }
84
85 /***
86 * Initialization of the ConfigFacility basically caches the
87 * properties provided during init() & returns them to the
88 * caller later. Simplest possible facility.
89 *
90 * @param p
91 * @since 1.1
92 */
93 public void init(Properties p) {
94 this.properties = p;
95 }
96
97 /***
98 * Returns a copy of the application configuration information.
99 *
100 * @return java.util.Properties
101 *
102 * @since 1.0
103 * @throws ConfigurationException
104 */
105 public Properties getProperties() throws ConfigurationException {
106
107 Properties copy = null;
108 // since hashtable (properties parent class) is synchronized, there
109 // is no need to double synch here, but if the implementation
110 // changes (e.g. to use a HashMap instead of Properties), access
111 // should be synchronized like so:
112 // synchronized (lock) {
113 copy = new Properties(this.properties);
114 // }
115 return copy;
116 }
117
118 /***
119 * Returns the property w/ the specified key.
120 *
121 * @param key
122 * @since 1.0
123 * @return
124 */
125 public String getProperty(String key) {
126 String value = null;
127 // see note in getProperties() method
128 // synchronized (lock) {
129 value = properties.getProperty(key);
130 // }
131 return value;
132 }
133
134 /***
135 * Cleanup the object pool that provides the connections.
136 *
137 * @since 1.0
138 */
139 public void close() {
140 this.properties.clear();
141 this.properties = null;
142 }
143
144 }
This page was automatically generated by Maven