001 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
002 *
003 * Copyright 2000-2013, Michael Meyling <mime@qedeq.org>.
004 *
005 * "Hilbert II" is free software; you can redistribute
006 * it and/or modify it under the terms of the GNU General Public
007 * License as published by the Free Software Foundation; either
008 * version 2 of the License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU General Public License for more details.
014 */
015
016 package org.qedeq.kernel.se.config;
017
018 import java.io.File;
019 import java.io.FileInputStream;
020 import java.io.FileOutputStream;
021 import java.io.IOException;
022 import java.io.InputStream;
023 import java.io.OutputStream;
024 import java.util.ArrayList;
025 import java.util.Collections;
026 import java.util.Enumeration;
027 import java.util.HashMap;
028 import java.util.Iterator;
029 import java.util.List;
030 import java.util.Map;
031 import java.util.Properties;
032
033 import org.qedeq.base.io.IoUtility;
034
035
036 /**
037 * This class reads entries from property files. This class should not
038 * be used outside this package.
039 *
040 * @author Michael Meyling
041 */
042 final class ConfigAccess {
043
044 /** Config file. */
045 private final File configFile;
046
047 /** Collector for properties. */
048 private Properties properties = new Properties();
049
050 /** Config file description. */
051 private final String description;
052
053 /**
054 * Get access for a config file.
055 *
056 * @param configFile Config file.
057 * @param description Config file description
058 * @throws IOException Config file couldn't be loaded.
059 */
060 public ConfigAccess(final File configFile, final String description) throws IOException {
061 this.configFile = configFile;
062 this.description = description;
063 FileInputStream stream = null;
064 try {
065 stream = new FileInputStream(configFile);
066 load(stream);
067 } catch (IOException e) {
068 System.out.println("no config file found, using default values");
069 } finally {
070 IoUtility.close(stream);
071 }
072 setString("configFileLocation", configFile.getCanonicalPath());
073 }
074
075 /**
076 * Get config file.
077 *
078 * @return Config file.
079 */
080 public final File getConfigFile() {
081 return configFile;
082 }
083
084 /**
085 * Get description for config file.
086 *
087 * @return Config file description.
088 */
089 public final String getConfigDescription() {
090 return description;
091 }
092
093 /**
094 * Get properties.
095 *
096 * @return properties.
097 */
098 private final Properties getProperties() {
099 return properties;
100 }
101
102 /**
103 * Load properties from stream. The properties are
104 * added to the previous ones.
105 *
106 * @param inStream load from this stream
107 * @throws IOException loading failed
108 */
109 private final void load(final InputStream inStream) throws IOException {
110 getProperties().load(inStream);
111 }
112
113 /**
114 * Store properties in config file.
115 *
116 * @throws IOException Saving failed.
117 */
118 public final void store() throws IOException {
119 OutputStream out = null;
120 try {
121 final File file = getConfigFile();
122 IoUtility.createNecessaryDirectories(file);
123 out = new FileOutputStream(file);
124 getProperties().store(out, getConfigDescription());
125 } finally {
126 if (out != null) {
127 try {
128 out.close();
129 } catch (IOException e) {
130 throw e;
131 } catch (Exception e) {
132 throw new IOException(e.toString());
133 }
134 }
135 }
136 }
137
138 /**
139 * Return String property.
140 *
141 * @param name Get this property.
142 * @return String for looked property. <code>null</code>, if property is missing.
143 */
144 public final String getString(final String name) {
145 return getProperties().getProperty(name);
146 }
147
148 /**
149 * Return String property.
150 *
151 * @param name Look for this String property.
152 * @param defaultValue Return this value if property doesn't exist.
153 * @return Value of property. Equal to default value if parameter doesn't exist.
154 */
155 public final String getString(final String name, final String defaultValue) {
156 final String value = getProperties().getProperty(name);
157 if (value == null) {
158 setString(name, defaultValue);
159 return defaultValue;
160 }
161 return value;
162 }
163
164 /**
165 * Set String property.
166 *
167 * @param name Set this property.
168 * @param value Set property to this value.
169 */
170 public final void setString(final String name, final String value) {
171 getProperties().setProperty(name, value);
172 }
173
174 /**
175 * Get list of String properties with certain prefix.
176 * Example:
177 * <ul>
178 * <li>qeq=green</li>
179 * <li>module2=tiger</li>
180 * <li>module3=tulip</li>
181 * <li>modula=green</li>
182 * <li>module1=bluebird</li>
183 * </ul>
184 * If namePrefix == "module" we get:
185 * <ul>
186 * <li>module1=bluebird</li>
187 * <li>module2=tiger</li>
188 * <li>module3=tulip</li>
189 * </ul>
190 * The sequence of resulting properties is sorted by their keys.
191 *
192 * @param namePrefix Prefix of seek property name.
193 * @return List of key sorted string properties (maybe empty).
194 */
195 public final String[] getStringProperties(final String namePrefix) {
196 final List list = new ArrayList();
197 final Enumeration keys = getProperties().keys();
198 final List keyList = Collections.list(keys);
199 Collections.sort(keyList);
200 for (int i = 0; i < keyList.size(); i++) {
201 final String key = (String) keyList.get(i);
202 if (key.startsWith(namePrefix)) {
203 list.add(getProperties().get(key));
204 }
205 }
206 return (String []) list.toArray(new String[list.size()]);
207 }
208
209 /**
210 * Get map of String properties with certain prefix.
211 *
212 * @param namePrefix Prefix of seek property name.
213 * @return Map of properties that have String keys that start with <code>namePrefix</code>.
214 * The prefix is removed of for the resulting map.
215 */
216 public final Map getProperties(final String namePrefix) {
217 final Map result = new HashMap();
218 Iterator i = getProperties().entrySet().iterator();
219 while (i.hasNext()) {
220 Map.Entry entry = (Map.Entry) i.next();
221 final String name = String.valueOf(entry.getKey());
222 if (name.startsWith(namePrefix)) {
223 result.put(name.substring(namePrefix.length()), entry.getValue());
224 }
225 }
226 return result;
227 }
228
229 /**
230 * Set int property.
231 *
232 * @param name Set this property.
233 * @param value Set property to this value.
234 */
235 public final void setInteger(final String name, final int value) {
236 setString(name, "" + value);
237 }
238
239
240 /**
241 * Get int property.
242 *
243 * @param name look for this property
244 * @return property
245 * @throws IllegalArgumentException Property is no valid int value
246 * @throws NullPointerException Property doesn't exist
247 */
248 public final int getInteger(final String name) {
249 final String intPropAsString = getProperties().getProperty(name);
250 if (intPropAsString == null) {
251 throw new NullPointerException("property \"" + name + "\" not found");
252 }
253 try {
254 return Integer.parseInt(intPropAsString);
255 } catch (NumberFormatException ex) {
256 throw new IllegalArgumentException(
257 "int property " + intPropAsString + " has invalid format");
258 }
259 }
260
261 /**
262 * Return int property.
263 *
264 * @param name Look for this integer property.
265 * @param defaultValue Return this value if property doesn't exist.
266 * @return int value of property. Equal to default value if parameter doesn't exist.
267 * @throws IllegalArgumentException Property is no valid int value.
268 */
269 public final int getInteger(final String name, final int defaultValue) {
270 final String intPropAsString = getProperties().getProperty(name);
271 if (intPropAsString == null || intPropAsString.length() == 0) {
272 setInteger(name, defaultValue);
273 return defaultValue;
274 }
275 try {
276 return Integer.parseInt(intPropAsString);
277 } catch (NumberFormatException ex) {
278 throw new IllegalArgumentException(
279 "Integer-Property " + intPropAsString + " has invalid format");
280 }
281 }
282
283 /**
284 * Remove property.
285 *
286 * @param name Property to delete.
287 */
288 public final void removeProperty(final String name) {
289 getProperties().remove(name);
290 }
291
292 /**
293 * Remove properties with certain prefix.
294 *
295 * Example:
296 * <ul>
297 * <li>module1=bluebird</li>
298 * <li>module2=tiger</li>
299 * <li>module3=tulip</li>
300 * </ul>
301 * Calling with value <code>module</code> deletes all.
302 *
303 * @param namePrefix Prefix of seeked property name.
304 */
305 public final void removeProperties(final String namePrefix) {
306 final Enumeration keys = getProperties().keys();
307 while (keys.hasMoreElements()) {
308 final String key = (String) keys.nextElement();
309 if (key.startsWith(namePrefix)) {
310 getProperties().remove(key);
311 }
312 }
313 }
314
315 }
|