DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG· RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT <http://issues.apache.org/bugzilla/show_bug.cgi?id=34362>. ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND· INSERTED IN THE BUG DATABASE.
http://issues.apache.org/bugzilla/show_bug.cgi?id=34362 ------- Additional Comments From [EMAIL PROTECTED] 2005-04-25 16:08 ------- [AbstractFileConfiguration.java] /* * Copyright 2004-2005 The Apache Software Foundation. * * Licensed under the Apache License, Version 2.0 (the "License") * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.commons.configuration; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.io.OutputStream; import java.io.OutputStreamWriter; import java.io.Reader; import java.io.UnsupportedEncodingException; import java.io.Writer; import java.net.URL; import java.util.Iterator; import org.apache.commons.configuration.reloading.InvariantReloadingStrategy; import org.apache.commons.configuration.reloading.ReloadingStrategy; /** * <p>Partial implementation of the <code>FileConfiguration</code> interface. * Developpers of file based configuration may want to extend this class, * the two methods left to implement are [EMAIL PROTECTED] AbstractFileConfiguration#load (Reader)} * and [EMAIL PROTECTED] AbstractFileConfiguration#save(Reader)}.</p> * <p>This base class already implements a couple of ways to specify the location * of the file this configuration is based on. The following possibilities * exist: * <ul><li>URLs: With the method <code>setURL()</code> a full URL to the * configuration source can be specified. This is the most flexible way. Note * that the <code>save()</code> methods support only <em>file:</em> URLs.</li> * <li>Files: The <code>setFile()</code> method allows to specify the * configuration source as a file. This can be either a relative or an * absolute file. In the former case the file is resolved based on the current * directory.</li> * <li>As file paths in string form: With the <code>setPath()</code> method a * full path to a configuration file can be provided as a string.</li> * <li>Separated as base path and file name: This is the native form in which * the location is stored. The base path is a string defining either a local * directory or a URL. It can be set using the <code>setBasePath()</code> * method. The file name, non surprisingly, defines the name of the configuration * file.</li></ul></p> * <p>Note that the <code>load()</code> methods do not wipe out the configuration's * content before the new configuration file is loaded. Thus it is very easy to * construct a union configuration by simply loading multiple configuration * files, e.g.</p> * <p><pre> * config.load(configFile1); * config.load(configFile2); * </pre></p> * <p>After executing this code fragment, the resulting configuration will * contain both the properties of configFile1 and configFile2. On the other * hand, if the current configuration file is to be reloaded, <code>clear() </code> * should be called first. Otherwise the properties are doubled. This behavior * is analogous to the behavior of the <code>load(InputStream)</code> method * in <code>java.util.Properties</code>.</p> * * @author Emmanuel Bourg * @version $Revision: 156237 $, $Date: 2005-03-05 05:26:22 -0500 (Sat, 05 Mar 2005) $ * @since 1.0-rc2 */ public abstract class AbstractFileConfiguration extends BaseConfiguration implements FileConfiguration { protected String fileName; protected String basePath; protected boolean autoSave; protected ReloadingStrategy strategy; private Object reloadLock = new Object(); private String encoding; private URL sourceURL = null; /** * Default constructor * * @since 1.1 */ public AbstractFileConfiguration() { setReloadingStrategy(new InvariantReloadingStrategy()); } /** * Creates and loads the configuration from the specified file. The passed * in string must be a valid file name, either absolute or relativ. * * @param fileName The name of the file to load. * * @throws ConfigurationException Error while loading the file * @since 1.1 */ public AbstractFileConfiguration(String fileName) throws ConfigurationException { this(); // store the file name setPath(fileName); // load the file load(); } /** * Creates and loads the configuration from the specified file. * * @param file The file to load. * @throws ConfigurationException Error while loading the file * @since 1.1 */ public AbstractFileConfiguration(File file) throws ConfigurationException { this(); // set the file and update the url, the base path and the file name setFile(file); // load the file if (file.exists()) { load(); } } /** * Creates and loads the configuration from the specified URL. * * @param url The location of the file to load. * @throws ConfigurationException Error while loading the file * @since 1.1 */ public AbstractFileConfiguration(URL url) throws ConfigurationException { this(); // set the URL and update the base path and the file name setURL(url); // load the file load(); } /** * Load the configuration from the underlying location. * * @throws ConfigurationException if loading of the configuration fails */ public void load() throws ConfigurationException { if(sourceURL != null) { load(sourceURL); } else { load(getFileName()); } } /** * Locate the specified file and load the configuration. * * @param fileName the name of the file loaded * * @throws ConfigurationException */ public void load(String fileName) throws ConfigurationException { try { URL url = ConfigurationUtils.locate(basePath, fileName); if (url == null) { throw new ConfigurationException("Cannot locate configuration source " + fileName); } load(url); } catch (ConfigurationException e) { throw e; } catch (Exception e) { throw new ConfigurationException(e.getMessage(), e); } } /** * Load the configuration from the specified file. * * @param file the loaded file * * @throws ConfigurationException */ public void load(File file) throws ConfigurationException { try { load(file.toURL()); } catch (ConfigurationException e) { throw e; } catch (Exception e) { throw new ConfigurationException(e.getMessage(), e); } } /** * Load the configuration from the specified URL. * * @param url the URL of the file loaded * * @throws ConfigurationException */ public void load(URL url) throws ConfigurationException { if(sourceURL == null) { sourceURL = url; } InputStream in = null; try { in = url.openStream(); load(in); } catch (ConfigurationException e) { throw e; } catch (Exception e) { throw new ConfigurationException(e.getMessage(), e); } finally { // close the input stream try { if (in != null) { in.close(); } } catch (IOException e) { e.printStackTrace(); } } } /** * Load the configuration from the specified stream, using the encoding * returned by [EMAIL PROTECTED] #getEncoding()}. * * @param in the input stream * * @throws ConfigurationException */ public void load(InputStream in) throws ConfigurationException { load(in, getEncoding()); } /** * Load the configuration from the specified stream, using the specified * encoding. If the encoding is null the default encoding is used. * * @param in the input stream * @param encoding the encoding used. <code>null</code> to use the default encoding * * @throws ConfigurationException */ public void load(InputStream in, String encoding) throws ConfigurationException { Reader reader = null; if (encoding != null) { try { reader = new InputStreamReader(in, encoding); } catch (UnsupportedEncodingException e) { throw new ConfigurationException( "The requested encoding is not supported, try the default encoding.", e); } } if (reader == null) { reader = new InputStreamReader(in); } load(reader); } /** * Save the configuration. * * @throws ConfigurationException */ public void save() throws ConfigurationException { if(sourceURL!=null) { save(sourceURL); } else { save(fileName); } strategy.init(); } /** * Save the configuration to the specified file. This doesn't change the * source of the configuration, use setFileName() if you need it. * * @param fileName * * @throws ConfigurationException */ public void save(String fileName) throws ConfigurationException { try { File file = ConfigurationUtils.getFile(basePath, fileName); if (file == null) { throw new ConfigurationException("Invalid file name for save: " + fileName); } save(file); } catch (ConfigurationException e) { throw e; } catch (Exception e) { throw new ConfigurationException(e.getMessage(), e); } } /** * Save the configuration to the specified URL if it's a file URL. * This doesn't change the source of the configuration, use setURL() * if you need it. * * @param url * * @throws ConfigurationException */ public void save(URL url) throws ConfigurationException { File file = ConfigurationUtils.fileFromURL(url); if (file != null) { save(file); } else { throw new ConfigurationException("Could not save to URL " + url); } } /** * Save the configuration to the specified file. The file is created * automatically if it doesn't exist. This doesn't change the source * of the configuration, use [EMAIL PROTECTED] #setFile} if you need it. * * @param file * * @throws ConfigurationException */ public void save(File file) throws ConfigurationException { OutputStream out = null; try { // create the file if necessary createPath(file); out = new FileOutputStream(file); save(out); } catch (IOException e) { throw new ConfigurationException(e.getMessage(), e); } finally { // close the output stream try { if (out != null) { out.close(); } } catch (IOException e) { e.printStackTrace(); } } } /** * Save the configuration to the specified stream, using the encoding * returned by [EMAIL PROTECTED] #getEncoding()}. * * @param out * * @throws ConfigurationException */ public void save(OutputStream out) throws ConfigurationException { save(out, getEncoding()); } /** * Save the configuration to the specified stream, using the specified * encoding. If the encoding is null the default encoding is used. * * @param out * @param encoding * @throws ConfigurationException */ public void save(OutputStream out, String encoding) throws ConfigurationException { Writer writer = null; if (encoding != null) { try { writer = new OutputStreamWriter(out, encoding); } catch (UnsupportedEncodingException e) { throw new ConfigurationException( "The requested encoding is not supported, try the default encoding.", e); } } if (writer == null) { writer = new OutputStreamWriter(out); } save(writer); } /** * Return the name of the file. */ public String getFileName() { return fileName; } /** * Set the name of the file. The passed in file name should not contain a * path. Use <code>[EMAIL PROTECTED] AbstractFileConfiguration#setPath(String) * setPath()}</code> to set a full qualified file name. * * @param fileName the name of the file */ public void setFileName(String fileName) { sourceURL = null; this.fileName = fileName; } /** * Return the base path. */ public String getBasePath() { return basePath; } /** * Set the base path. Relative configurations are loaded from this path. * The base path can be either a path to a directory or a URL. * * @param basePath the base path. */ public void setBasePath(String basePath) { sourceURL = null; this.basePath = basePath; } /** * Return the file where the configuration is stored. If the base path is * a URL with a protocol different than "file", the return value * will not point to a valid file object. * * @return the file where the configuration is stored */ public File getFile() { return ConfigurationUtils.getFile(getBasePath(), getFileName()); } /** * Set the file where the configuration is stored. The passed in file is * made absolute if it is not yet. Then the file's path component becomes * the base path and its name component becomes the file name. * * @param file the file where the configuration is stored */ public void setFile(File file) { sourceURL = null; setFileName(file.getName()); setBasePath((file.getParentFile() != null) ? file.getParentFile ().getAbsolutePath() : null); } /** * Returns the full path to the file this configuration is based on. The * return value is valid only if this configuration is based on a file on * the local disk. * * @return the full path to the configuration file */ public String getPath() { return getFile().getAbsolutePath(); } /** * Sets the location of this configuration as a full path name. The passed * in path should represent a valid file name. * * @param path the full path name of the configuration file */ public void setPath(String path) { setFile(new File(path)); } /** * Return the URL where the configuration is stored. * * @return the configuration's location as URL */ public URL getURL() { return ConfigurationUtils.locate(getBasePath(), getFileName()); } /** * Set the location of this configuration as a URL. For loading this can be * an arbitrary URL with a supported protocol. If the configuration is to * be saved, too, a URL with the "file" protocol should be * provided. * * @param url the location of this configuration as URL */ public void setURL(URL url) { setBasePath(ConfigurationUtils.getBasePath(url)); setFileName(ConfigurationUtils.getFileName(url)); } public void setAutoSave(boolean autoSave) { this.autoSave = autoSave; } public boolean isAutoSave() { return autoSave; } /** * Save the configuration if the automatic persistence is enabled * and if a file is specified. */ protected void possiblySave() { if (autoSave && fileName != null) { try { save(); } catch (ConfigurationException e) { throw new ConfigurationRuntimeException("Failed to auto-save", e); } } } protected void addPropertyDirect(String key, Object obj) { super.addPropertyDirect(key, obj); possiblySave(); } public void clearProperty(String key) { super.clearProperty(key); possiblySave(); } public ReloadingStrategy getReloadingStrategy() { return strategy; } public void setReloadingStrategy(ReloadingStrategy strategy) { this.strategy = strategy; strategy.setConfiguration(this); strategy.init(); } public void reload() { synchronized (reloadLock) { if (strategy.reloadingRequired()) { try { clear(); load(); // notify the strategy strategy.reloadingPerformed(); } catch (Exception e) { e.printStackTrace(); // todo rollback the changes if the file can't be reloaded } } } } public Object getProperty(String key) { reload(); return super.getProperty(key); } public boolean isEmpty() { reload(); return super.isEmpty(); } public boolean containsKey(String key) { reload(); return super.containsKey(key); } public Iterator getKeys() { reload(); return super.getKeys(); } /** * Create the path to the specified file. */ private void createPath(File file) { if (file != null) { // create the path to the file if the file doesn't exist if (!file.exists()) { File parent = file.getParentFile(); if (parent != null && !parent.exists()) { parent.mkdirs(); } } } } public String getEncoding() { return encoding; } public void setEncoding(String encoding) { this.encoding = encoding; } } -- Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the assignee for the bug, or are watching the assignee. --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
