Mercurial > dive4elements > framework
view artifacts-common/src/main/java/org/dive4elements/artifacts/common/utils/Config.java @ 560:2b631f788ce1
modules-Config-Dir introduced
author | gernotbelger |
---|---|
date | Tue, 04 Sep 2018 16:44:31 +0200 |
parents | 609ced80bcf0 |
children |
line wrap: on
line source
/* * Copyright (c) 2010 by Intevation GmbH * * This program is free software under the LGPL (>=v2.1) * Read the file LGPL.txt coming with the software for details * or visit http://www.gnu.org/licenses/ if it does not exist. */ package org.dive4elements.artifacts.common.utils; import java.io.BufferedInputStream; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; import java.util.Properties; import javax.xml.namespace.QName; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import javax.xml.xpath.XPathConstants; import org.apache.log4j.Logger; import org.w3c.dom.Document; import org.w3c.dom.Node; import org.w3c.dom.NodeList; import org.xml.sax.SAXException; /** * The central access to the configuration of the artifact database. * This class provides some static methods to access the central * configuration XML file via XPath. * * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> */ public final class Config { private static Logger logger = Logger.getLogger(Config.class); /** * System property name where to find the configuration directory. */ public static final String CONFIG_DIR = "artifact.database.dir"; /** * Default path to the configuration directory if none * was specified by the CONFIG_DIR system property. */ public static final File CONFIG_DIR_DEFAULT = new File(new File(System.getProperty("user.home", System.getProperty("user.dir", "."))), ".artifactdb"); /** * Name of the central configuration XML file. */ public static final String CONFIG_FILE = "conf.xml"; /** * Name of the configuration filename alias to be use * within the configuration. This alias is replaced by * the real path. */ public static final String CONFIG_DIR_PLACEHOLDER = "${artifacts.config.dir}"; private static Document config; private Config() { } /** * Singleton access to the central XML configuration document. * * @return The central XML configuration document. */ public static synchronized final Document getConfig() { if (config == null) { config = loadConfig(); } return config; } public static Properties loadProperties(final String CONFIG_FILE_LOCAL, final File configDir) throws IOException { final File configFile = new File(configDir, CONFIG_FILE_LOCAL); InputStream reader = null; try { reader = new BufferedInputStream(new FileInputStream(configFile)); final Properties properties = new Properties(); properties.load(reader); return properties; } finally { try { if (reader != null) reader.close(); } catch (final IOException e1) { e1.printStackTrace(); } } } /** * Returns the path to the configuartion directory. If a path * was specified via the CONFIG_DIR system property this one * is used. Else it falls back to default configuration path. * * @return The path to the configuartion directory. */ public static File getConfigDirectory() { final String configDirString = System.getProperty(CONFIG_DIR); File configDir = configDirString != null ? new File(configDirString) : CONFIG_DIR_DEFAULT; if (!configDir.isDirectory()) { logger.warn("'" + configDir + "' is not a directory."); configDir = CONFIG_DIR_DEFAULT; } return configDir; } /** * returns the path to modules-config, which is a subfolder of config */ public static File getModulesConfigDirectory() { final File configDir = getConfigDirectory(); final File modulesCfgFile = new File(configDir, "modules"); if (!modulesCfgFile.isDirectory()) { logger.warn("'" + modulesCfgFile + "' is not a directory."); return CONFIG_DIR_DEFAULT; // or null? } return modulesCfgFile; } /** * Replaces the CONFIG_DIR_PLACEHOLDER alias with the real path * of the configuration directory. * * @param path * The path containing the CONFIG_DIR_PLACEHOLDER placeholder. * @return The path where the CONFIG_DIR_PLACEHOLDER placeholders are * replaced by the real path name. */ public static String replaceConfigDir(final String path) { final String configDir = getConfigDirectory().getAbsolutePath(); return path.replace(CONFIG_DIR_PLACEHOLDER, configDir); } private static Document loadConfig() { final File configDir = getConfigDirectory(); final File file = new File(configDir, CONFIG_FILE); if (!file.canRead() && !file.isFile()) { logger.error("Cannot read config file '" + file + "'."); return null; } try { final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); factory.setValidating(false); // XXX: This may change in future. return factory.newDocumentBuilder().parse(file); } catch (final SAXException se) { logger.error(se.getLocalizedMessage(), se); } catch (final ParserConfigurationException pce) { logger.error(pce.getLocalizedMessage(), pce); } catch (final IOException ioe) { logger.error(ioe.getLocalizedMessage()); } return null; } /** * Convenience method to search within a given document tree via XPath. * See {@link XMLUtils#xpath(Object, String, QName) } for details. * * @param root * The object which is used as the root of the tree to * be searched in. * @param query * The XPath query. * @param returnType * The type of the result. * @return The result of type 'returnTyp' or null if something went * wrong during XPath evaluation. */ public static final Object getXPath(final Object root, final String query, final QName returnType) { return XMLUtils.xpath(root, query, returnType); } /** * Convenience method to search within the central configuration via XPath. * See {@link XMLUtils#xpath(Object, String, QName) } for details. * * @param query * The XPath query. * @param returnType * The type of the result. * @return The result of type 'returnTyp' or null if something went * wrong during XPath evaluation. */ public static final Object getXPath(final String query, final QName returnType) { return XMLUtils.xpath(getConfig(), query, returnType); } /** * Convenience method to search for a node list within the central * configuation document via XPath. * * @param query * The XPath query. * @return The queried node list or null if something went * wrong during XPath evaluation. */ public static final NodeList getNodeSetXPath(final String query) { return (NodeList) getXPath(query, XPathConstants.NODESET); } /** * Convenience method to search for a node within the central * configuation document via XPath. * * @param query * The XPath query. * @return The queried node or null if something went * wrong during XPath evaluation. */ public static final Node getNodeXPath(final String query) { return (Node) getXPath(query, XPathConstants.NODE); } /** * Convenience method to search for a string within the central * configuation document via XPath. * * @param xpath * The XPath query. * @return The queried string or null if something went * wrong during XPath evaluation. */ public static final String getStringXPath(final String xpath) { return getStringXPath(xpath, null); } /** * Convenience method to search for a string within the central * configuation document via XPath. * * @param query * The XPath query. * @param def * The string to be returned if the search has no results. * @return The queried string or the default value if something went * wrong during XPath evaluation. */ public static final String getStringXPath(final String query, final String def) { final String s = (String) getXPath(query, XPathConstants.STRING); return s == null || s.length() == 0 ? def : s; } /** * Convenience method to search for a node list within a given tree * via XPath. * * @param root * The root of the tree to be searched in. * @param query * The XPath query. * @return The queried node list or null if something went * wrong during XPath evaluation. */ public static final NodeList getNodeSetXPath(final Object root, final String query) { return (NodeList) getXPath(root, query, XPathConstants.NODESET); } /** * Convenience method to search for a node within a given tree * via XPath. * * @param root * The root of the tree to be searched in. * @param query * The XPath query. * @return The queried node or null if something went * wrong during XPath evaluation. */ public static final Node getNodeXPath(final Object root, final String query) { return (Node) getXPath(root, query, XPathConstants.NODE); } /** * Convenience method to search for a string within a given tree * via XPath. * * @param root * The root of the tree to be searched in. * @param xpath * The XPath query. * @return The queried string or null if something went * wrong during XPath evaluation. */ public static final String getStringXPath(final Object root, final String xpath) { return getStringXPath(root, xpath, null); } /** * Convenience method to search for a string within a given tree * via XPath. * * @param root * The root of the tree to be searched in. * @param query * xpath The XPath query. * @param def * The string to be returned if the search has no results. * @return The queried string or the default value if something went * wrong during XPath evaluation. */ public static final String getStringXPath(final Object root, final String query, final String def) { final String s = (String) getXPath(root, query, XPathConstants.STRING); return s == null || s.length() == 0 ? def : s; } } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :