View Javadoc
   /* ====================================================================
    * License: 
    * 
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    *
    * 1. Redistributions of source code must retain the above copyright
    *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by 
   *        Robert Half International (http://www.rhi.com/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Parc", "RHI", and "Robert Half International" must
   *    not be used to endorse or promote products derived from this
   *    software without prior written permission. For written
   *    permission, please contact pete.mckinstry@rhi.com.
   *
   * 5. Products derived from this software may not be called "PARC",
   *    nor may "PARC" appear in their name, without prior written
   *    permission of Robert Half International.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   */
  package com.rhi.architecture.logging;
  
  import com.rhi.architecture.config.ConfigurationException;
  import com.rhi.architecture.resource.ResourceContext;
  
  /***
   * Helper method to creating Logger instance.
   *
   * @author Pete McKinstry
   * @copyright 2002, Robert Half Int'l., Inc. All rights reserved.
   *
   * @since 1.0
   */
  public class LogUtil {
  
     /***
      * Get the appropriate Logger instance for this Interface
      *
      * @return DataSource
      *
      * @since 1.0
      * @throws ConfigurationException
      */
     public static Logger getLogger() throws ConfigurationException {
        Logger logger = null;
  
        ResourceContext ctx = new ResourceContext();
        // try the new Logging model.
        LogFactory factory = (LogFactory) ctx.lookup(LogFactory.KEY);
        if (factory == null) {
           // no factory registered, fall back to the old model
           logger = (Logger) ctx.lookup(Logger.KEY);
        }
        else {
           logger = factory.getDefaultLogger();
        }
  
        if (logger == null) {
           throw new ConfigurationException("unable to load logger. Resource not found");
        }
        return logger;
     }
  
     /***
      * This helper method requires that the LogFactory is registered w/ 
      * the ResourceContext. It follows the new Logging model.
      * 
      * @param name - the name of the logger.
      * @return Logger
      * @throws ConfigurationException
      */
     public static Logger getLogger(String name)
        throws ConfigurationException {
       Logger logger = internalGetLogger(name);
 
       if (logger == null) {
          throw new ConfigurationException(
             "unable to load logger. Resource not found");
       }
       return logger;
    }
 
    /***
     * This helper method requires that the LogFactory is registered w/ 
     * the ResourceContext. It follows the new Logging model.
     * 
     * @param type - the name of the logger.
     * @return Logger
     * @throws ConfigurationException
     */
    public static Logger getLogger(Class type)
       throws ConfigurationException {
       Logger logger = internalGetLogger(type.getName());
       
       if (logger == null) {
          throw new ConfigurationException(
             "unable to load logger. Resource not found");
       }
       return logger;
    }
 
    /***
     * This method allows failures to be logged, even if the failure 
     * is in the logging package. 
     * @return Logger
     */
    public static Logger getDefaultLogger() {
       return new DefaultLogger();
    }
 
    /***
     * helper method
     * 
     * @param name
     * @return Logger
     */
    private static Logger internalGetLogger(String name) {
       Logger logger = null;
       LogFactory factory = getFactory();
       if (factory != null) {
          logger = factory.getLogger(name);
       }
       return logger;
    }
    
    /***
     * helper method
     * 
     * @return LogFactory
     */
    private static LogFactory getFactory() { 
       ResourceContext ctx = new ResourceContext();
       return (LogFactory) ctx.lookup(LogFactory.KEY);
    }
 
 }