vmassol     01/04/28 07:05:02

  Added:       cactus/src/framework/share/org/apache/commons/cactus/client
                        ClientConfigurationChecker.java
  Log:
  class used to make some checks about user environment to ensure setup is fine (for 
example, check that the cactus.properties file is in the CLASSPATH)
  
  Revision  Changes    Path
  1.1                  
jakarta-commons/cactus/src/framework/share/org/apache/commons/cactus/client/ClientConfigurationChecker.java
  
  Index: ClientConfigurationChecker.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights
   * reserved.
   *
   * 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 acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Ant", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact [EMAIL PROTECTED]
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * 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.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  package org.apache.commons.cactus.client;
  
  import java.util.*;
  import java.io.*;
  
  import org.apache.commons.cactus.*;
  
  /**
   * Helper class that checks configuration parameters (for the client side)
   * like if the CLASSPATH contains the jar for the Servlet API, if the
   * <code>cactus.properties</code> file is in the CLASSPATH, ...
   *
   * @version @version@
   * @author Vincent Massol <a 
href="mailto:[EMAIL PROTECTED]";>[EMAIL PROTECTED]</a> 
   */
  public class ClientConfigurationChecker
  {
      /**
       * Checks if the <code>cactus.properties</code> file is in the CLASSPATH.
       *
       * @exception RuntimeException if the properties file is not in the
       *            CLASSPATH.
       */
      public static void checkConfigProperties()
      {
          InputStream is = ClientConfigurationChecker.class.getResourceAsStream( 
              "/" + AbstractHttpClient.CONFIG_NAME + ".properties");
          
          if (is == null) {
              String msg = "The Cactus '" + AbstractHttpClient.CONFIG_NAME + 
".properties' ";
              msg += "configuration file need to be present in the java CLASSPATH";
              msg += "(i.e. the directory that contains it need to be added to the 
CLASSPATH).";
              throw new RuntimeException(msg);
          }
  
      }
  
  }
  
  
  

Reply via email to