JProp.java

/*
 * JOnAS: Java(TM) Open Application Server
 * Copyright (C) 1999 Bull S.A.
 * Contact: jonas-team@objectweb.org
 * 
 * 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 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
 *
 * Initial developer(s): ____________________________________.
 * Contributor(s): Adriana Danes
 *
 * --------------------------------------------------------------------------
 * $Id: JProp.java,v 1.19 2004/03/22 13:09:00 benoitf Exp $
 * --------------------------------------------------------------------------
 */


package org.objectweb.jonas.common;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.FileNotFoundException;
import java.io.FileWriter;
import java.io.IOException;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Properties;
import java.util.StringTokenizer;
import javax.naming.Context;


public class JProp {

    public static final String JONASPREFIX = "jonas";

    public static final String DOMAIN_NAME = "domain.name";

    public static final String JONAS_NAME = "jonas.name";

    public static final String JONAS_DEF_NAME = "jonas";

    private static final String JONAS_BASE = "jonas.base";
    
    private static final String CONFIG_DIR = "conf";

    private static Properties systEnv = System.getProperties();  

    private static String jonasBase = systEnv.getProperty(JONAS_BASE);

    private static String installRoot = systEnv.getProperty("install.root");

    private static String fileSeparator = systEnv.getProperty("file.separator");

    private static String homeUser = systEnv.getProperty("user.home");

    private String configFileXml  = null;

    private Properties configFileEnv  = new Properties();

    private Properties allEnv = null;

    private String propFileName = null;

    private static JProp unique = null;

    private static Hashtable multiple = new Hashtable();

    private JProp(String fileName) throws Exception {
        readFile(fileName);
    }

    private JProp() throws Exception {
        readFile(JONASPREFIX);
    }

    private JProp(String fileName, Properties props) throws Exception {
        writePropsToFile(fileName, props);
    }

    private JProp(String fileName, String txt) throws Exception {
        writeXmlToFile(fileName, txt);
    }

    public static JProp getInstance() throws Exception {
        if (unique == null) {
            unique = new JProp();
        }
        return unique;
    }

    public static JProp getInstance(String fileName) throws Exception {
        if (!multiple.containsKey(fileName)) {
            multiple.put(fileName, new JProp(fileName));
        }
        return (JProp) multiple.get(fileName);
    }

    public static JProp getInstance(String fileName, Properties props) throws Exception {
        if (!multiple.containsKey(fileName)) {
            multiple.put(fileName, new JProp(fileName, props));
        }
        return (JProp) multiple.get(fileName);
    }

    private void writePropsToFile(String fileName, Properties props) throws Exception {

        // Check the JONAS_BASE environment property
        if (jonasBase == null) {
            throw new Exception("JOnAS configuration error: environment property jonas.base not set!");
        }
        jonasBase = jonasBase.trim();

        // JONAS_BASE/conf/fileName
        propFileName = jonasBase + fileSeparator + CONFIG_DIR + fileSeparator + fileName + ".properties";

        try {
            FileOutputStream os = new FileOutputStream(propFileName);
            props.store(os, "This file is generated by JOnAS");
            os.close();
        } catch (FileNotFoundException e) {
            // File propFileName could not be opened
            propFileName = null;
            throw e;
        }
        configFileEnv = (Properties) props.clone();
        allEnv = configFileEnv;
    }


    private void writeXmlToFile(String fileName, String txt) throws Exception {

        // Check the JONAS_BASE environment property
        if (jonasBase == null) {
            throw new Exception("JOnAS configuration error: environment property jonas.base not set!");
        }
        jonasBase = jonasBase.trim();

        // JONAS_BASE/conf/fileName
        propFileName = jonasBase + fileSeparator + CONFIG_DIR + fileSeparator + fileName + ".properties";

        try {
            BufferedWriter out = new BufferedWriter(new FileWriter(new File(propFileName)));
            out.write(txt);
            out.flush();
            out.close();
        } catch (FileNotFoundException e) {
            // File propFileName could not be opened
            propFileName = null;
            throw e;
        }
    }


    private void readFile(String fileName) throws Exception {

        // Check the JONAS_BASE environment property
        if (jonasBase == null) {
            throw new Exception("JOnAS configuration error: environment property jonas.base not set!");
        }
        jonasBase = jonasBase.trim();

        // JONAS_BASE/conf/fileName
        String fileFullPathname = jonasBase + fileSeparator + CONFIG_DIR + fileSeparator + fileName;

        if (fileFullPathname.toLowerCase().endsWith(".xml")) {
            readXmlFile(fileFullPathname);
        } else {
            readPropsFile(fileFullPathname);
        }
    }


    private void readPropsFile(String fileName) throws Exception {

        // Update filename of this JProp
        this.propFileName = fileName;

        if (!fileName.endsWith(".properties")) {
            propFileName += ".properties";
        }

        File f = null;
        try {
            f = new File(propFileName);
            FileInputStream is = new FileInputStream(f);
            configFileEnv.load(is);
        } catch (FileNotFoundException e) {
            throw new FileNotFoundException("Cannot find properties for " + propFileName);
        } catch (IOException e) {
            System.err.println(e);
        }

        allEnv = (Properties) configFileEnv.clone(); 
        // Overriddes with syst properties
        if (f.getName().equalsIgnoreCase("jonas.properties")) {
            for (Enumeration e = systEnv.keys(); e.hasMoreElements();) {
                Object key   = e.nextElement();
                String value = ((String) systEnv.get(key)).trim();
                allEnv.put(key, (Object) value);
            }

            String serverName;         
            if (!systEnv.containsKey(JONAS_NAME)) {
                allEnv.put(JONAS_NAME, JONAS_DEF_NAME);
            } 
            serverName = ((String) allEnv.get(JONAS_NAME)).trim();

            if (!allEnv.containsKey(DOMAIN_NAME) && !systEnv.containsKey(DOMAIN_NAME)) {
                allEnv.put(DOMAIN_NAME, serverName);
            }
        }
    }

    private void readXmlFile(String fileName) throws Exception {

        // Update filename of this JProp
        this.propFileName = fileName;
   
        try {        
            File f = new File(propFileName);
            int length = (int) f.length();
            FileInputStream fis = new FileInputStream(f);
            byte[] buffer = new byte[length];
            fis.read(buffer);
            fis.close();
            configFileXml = new String(buffer);
        } catch (FileNotFoundException e) {
            throw new FileNotFoundException("Cannot find file " + propFileName);
        } catch (IOException e) {
            System.err.println(e);
        }
    }

    public static String getInstallRoot() {
        // Check install.root system property
        if (installRoot == null) {
            throw new RuntimeException("JOnAS configuration error: System property install.root not set!");
        }
        return installRoot;
    }

    public static String getJonasBase() {
        return jonasBase;
    }

    public static String getWorkDir() {
        return jonasBase + File.separator + "work";
    }

    public String getPropFile() {
        return propFileName;
    }

    public Properties getEnv() {
        return allEnv;
    }


    public Properties getConfigFileEnv() {
        return configFileEnv;
    }

    public String getConfigFileXml() {
        return configFileXml;
    }

    public String getValue(String key, String defaultVal) {
        String retProperty = allEnv.getProperty(key, defaultVal);
        return retProperty.trim();
    }

    public String getValue(String key) {

        String retProperty = allEnv.getProperty(key);
        if (retProperty != null) {
            retProperty = retProperty.trim();
        }
        return retProperty;
    }

    public boolean getValueAsBoolean(String key, boolean def) {
        boolean ret = def;
        String value = this.getValue(key);
        if (value != null && value.equalsIgnoreCase("true")) {
            ret = true;
        }
        return ret;
    }

    public String[] getValueAsArray(String key) {

        String [] res = null;
        String value = this.getValue(key);
        if (value != null) {
            StringTokenizer st = new StringTokenizer(value, ",");
            res = new String [st.countTokens()];
            int i = 0;
            while (st.hasMoreTokens()) {
                res[i++] = st.nextToken().trim();
            }
        }
        return res;
    }

    public String toString() {
        String s = new String();
        for (Enumeration e = this.configFileEnv.keys(); e.hasMoreElements();) {
            Object key   = e.nextElement();
            Object value = this.configFileEnv.get(key);
            s = s.concat("   " + key + " = " + value + "\n");
        }
        if (s.length() > 0) {
            // take of the last '\n'
            s = s.substring(0, s.length() - 1);
        }
        return s;
    }

    public void env2Ctx(Context ctx) throws Exception {
        Enumeration e = configFileEnv.propertyNames();
        String key = null;
        while (e.hasMoreElements()) {
            key = (String) e.nextElement();
            ctx.bind(key, configFileEnv.getProperty(key, ""));
        }
    }

    public static void main(String args[]) {

        JProp jonasProperties = null;
        try {
            jonasProperties = JProp.getInstance();
        } catch (Exception e) {
            System.err.println(e);
            System.exit(2);
        }
        for (Enumeration e = jonasProperties.configFileEnv.keys(); e.hasMoreElements();) {
            Object key   = e.nextElement();
            Object value = jonasProperties.configFileEnv.get(key);
            System.out.println(key.toString() + "=" + value.toString());
        }
    }


}

---