/**
* ========================================
* JFreeReport : a free Java report library
* ========================================
*
* Project Info: http://reporting.pentaho.org/
*
* (C) Copyright 2000-2007, by Object Refinery Limited, Pentaho Corporation and Contributors.
*
* This library is free software; you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License as published by the Free Software Foundation;
* either version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* [Java is a trademark or registered trademark of Sun Microsystems, Inc.
* in the United States and other countries.]
*
* ------------
* $Id: FileConfigStorage.java 3525 2007-10-16 11:43:48Z tmorgner $
* ------------
* (C) Copyright 2000-2005, by Object Refinery Limited.
* (C) Copyright 2005-2007, by Pentaho Corporation.
*/
package org.jfree.report.modules.preferences.filesystem;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.Properties;
import org.jfree.base.config.HierarchicalConfiguration;
import org.jfree.base.config.ModifiableConfiguration;
import org.jfree.report.modules.preferences.base.ConfigFactory;
import org.jfree.report.modules.preferences.base.ConfigStorage;
import org.jfree.report.modules.preferences.base.ConfigStoreException;
import org.jfree.util.Configuration;
/**
* The FileConfigStorage is a storage provider that stores its content on the
* local filesystem. The directory used contains the data as plain text property
* files.
*
* @author Thomas Morgner
*/
public class FileConfigStorage implements ConfigStorage
{
/** The base directory of the storage provider. */
private final File baseDirectory;
/** The configuration header text that is appended to all property files. */
private static final String CONFIGHEADER =
"part of the jfreereport filesystem config store";
/**
* Creates a new file config storage and stores the contents in the given
* directory.
*
* @param baseDirectory the directory that should contain the files.
*/
public FileConfigStorage(final File baseDirectory)
{
this.baseDirectory = baseDirectory;
}
/**
* Stores the given properties on the defined path.
* <p/>
* This implementation stores the data as property files.
*
* @param configPath the configuration path that specifies where to store the
* properties.
* @param properties the properties which should be stored.
* @throws ConfigStoreException if an error occured.
* @see org.jfree.report.modules.misc.configstore.base.ConfigStorage
* #storeProperties(java.lang.String, java.util.Properties)
*/
public void store(final String configPath, final Configuration config)
throws ConfigStoreException
{
if (ConfigFactory.isValidPath(configPath) == false)
{
throw new IllegalArgumentException("The give path is not valid.");
}
final Enumeration keys = config.getConfigProperties();
final Properties properties = new Properties();
while (keys.hasMoreElements())
{
final String key = (String) keys.nextElement();
final String value = config.getConfigProperty(key);
if (value != null && key != null)
{
properties.put(key, value);
}
}
final File target = new File(baseDirectory, configPath);
if (target.exists() == true && target.canWrite() == false)
{
return;
}
try
{
final OutputStream out = new BufferedOutputStream(new FileOutputStream(
target));
properties.store(out, CONFIGHEADER);
out.close();
}
catch (Exception e)
{
throw new ConfigStoreException("Failed to write config " + configPath, e);
}
}
/**
* Loads the properties from the given path, specifying the given properties
* as default.
*
* @param configPath the configuration path from where to load the
* properties.
* @param defaults the property set that acts as fallback to provide default
* values.
* @return the loaded properties.
* @throws ConfigStoreException if an error occured.
*/
public Configuration load(final String configPath,
final Configuration defaults)
throws ConfigStoreException
{
if (ConfigFactory.isValidPath(configPath) == false)
{
throw new IllegalArgumentException("The given path is not valid.");
}
try
{
final Properties properties = new Properties();
final File target = new File(baseDirectory, configPath);
final InputStream in = new BufferedInputStream(new FileInputStream(
target));
properties.load(in);
in.close();
final ModifiableConfiguration config = new HierarchicalConfiguration(defaults);
final Iterator keys = properties.keySet().iterator();
while (keys.hasNext())
{
final String key = (String) keys.next();
config.setConfigProperty(key, properties.getProperty(key));
}
return config;
}
catch (Exception e)
{
throw new ConfigStoreException("Failed to read config" + configPath, e);
}
}
/**
* Tests, whether some configuration data exists for the given configuration.
*
* @param configPath the configuration path to the property storage.
* @return true, if there are properties under this path, false otherwise.
*/
public boolean isAvailable(final String configPath)
{
if (ConfigFactory.isValidPath(configPath) == false)
{
throw new IllegalArgumentException("The give path is not valid.");
}
final File target = new File(baseDirectory, configPath);
return target.exists() && target.canRead();
}
public String toString()
{
return "FileConfigStorage={baseDir=" + baseDirectory + "}";
}
}