/*
    * 
    * $Revision: 1.3 $
    * $Date: 2004/06/20 12:18:39 $
    *
    * ====================================================================
    * struts-it
    * Copyright (C) 2004 - strutsit community
    * 
   * 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.
   *
   * created: 2004-06-05  Manfred Wolff
   */
  package org.strutsit.chain.configuration;
  
  import java.io.InputStream;
  import java.util.Properties;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  /***
   * Reads the configuration of the chain-conf framework. If no configuration file
   * named <code>chain.properties</code> is found in the classpath defaults will
   * be set.
   * 
   * @author <a href="mailto:wolff@struts-it.de">Manfred Wolff </a>
   * @since JDK 1.4
   * @version $Revision: 1.3 $
   */
  public final class PropertyReader {
  
      /***
       * XML mode
       */
      public static final String XML_MODE = "xml";
  
      /***
       * Property mode
       */
      public static final String PROP_MODE = "prop";
  
      /***
       * Class mode
       */
      public static final String CLASS_MODE = "class";
  
      private static final String CONF_FILE = "/chain.properties";
  
      private static final String DEFAULT_PATH = "/org/strutsit/chain/config";
  
      private static final String DEFAULT_NAME = "/chain-config.xml";
  
      private static final String PROP_MODE_STRING = "chain.configuration";
  
      private static final String CONF_FILE_STRING = "configuration.name";
  
      private static final String CONF_XML_CLASS = "chain.configuration.xml";
  
      /***
       * The logger for this class (commons-logging).
       */
      private static Log log = LogFactory.getLog(PropertyReader.class);
  
      /***
       * Configuration mode. Maybe xml, prop or class.
       */
      private String configMode = XML_MODE;
  
      /***
       * Name of the configuration file
       */
      private String confName = DEFAULT_PATH + DEFAULT_NAME;
  
      /***
       * The Default-Configurationclass for the XML Configuration
       */
      private String xmlClass = "org.strutsit.chain.configuration.ChainXMLConfiguration";
  
      /***
       * The Instance of this singleton
       */
      private static PropertyReader instance;
  
      /***
       * @return Returns the configMode.
       */
      public String getConfigMode() {
          return configMode;
     }
 
     /***
      * @param configMode
      *            The configMode to set.
      */
     public void setConfigMode(String configMode) {
         this.configMode = configMode;
     }
 
     /***
      * @return Returns the confName.
      */
     public String getConfName() {
         return confName;
     }
 
     /***
      * @param confName
      *            The confName to set.
      */
     public void setConfName(String confName) {
         this.confName = confName;
     }
 
     /***
      * @return Returns the confName.
      */
     public String getXmlClass() {
         return xmlClass;
     }
 
     /***
      * @param className
      *            The className to set.
      */
     public void setXmlClass(String className) {
         this.xmlClass = className;
     }
 
     /***
      * Hiding the default constructor
      */
     private PropertyReader() {
         super();
     }
 
     /***
      * Factorymethod for the Reader-Object.
      * 
      * @return The one and only instance of this class.
      */
     public static synchronized PropertyReader getInstance() {
 
         if (log.isTraceEnabled()) {
             log.trace("getInstance -> START");
         }
         if (instance == null) {
             instance = new PropertyReader();
             instance.init();
         }
         if (log.isTraceEnabled()) {
             log.trace("getInstance -> END");
         }
         return instance;
     }
 
     /***
      * Inits the Reader.
      */
     private void init() {
 
         if (log.isTraceEnabled()) {
             log.trace("init -> START");
         }
         // First look, if there is a chain.properties file in the classpath
         InputStream stream = this.getClass().getResourceAsStream(CONF_FILE);
         if (stream != null) {
 
             Properties prop = new Properties();
             try {
                 prop.load(stream);
             } catch (Exception e) {
                 ; // nothing to do
                 log.warn("init -> No Property file available");
             }
 
             // Set confMode only if it is xml|prop|class
             String tempConfMode = prop.getProperty(PROP_MODE_STRING);
             if (XML_MODE.equals(tempConfMode) || PROP_MODE.equals(tempConfMode)
                     || CLASS_MODE.equals(tempConfMode)) {
                 setConfigMode(tempConfMode);
 
             }
 
             String tempName = prop.getProperty(CONF_FILE_STRING);
             if (tempName != null) {
                 setConfName(tempName);
             }
 
             String xmlclass = prop.getProperty(CONF_XML_CLASS);
             if (xmlclass != null) {
                 setXmlClass(xmlclass);
             }
         }
         if (log.isTraceEnabled()) {
             log.trace("init -> END");
         }
     }
 }