tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r...@apache.org
Subject cvs commit: jakarta-tomcat-4.0/catalina/src/share/org/apache/naming/factory BeanFactory.java
Date Sun, 02 Sep 2001 01:17:47 GMT
remm        01/09/01 18:17:47

  Added:       catalina/src/share/org/apache/naming/factory
                        BeanFactory.java
  Log:
  - Add new resource factory for resource objects conforming to the JavaBean
    component model. This resource factory is fully generic.
  - More specifically the class of the resource to be instanciated must :
    - have a public default constructor
    - have all its important properties be of simple types
  - See the (very straightforward) example in the Javadoc for more details.
  - Thanks to Aner Perez <aner at ncstech.com> for contributing this code.
  
  Revision  Changes    Path
  1.1                  jakarta-tomcat-4.0/catalina/src/share/org/apache/naming/factory/BeanFactory.java
  
  Index: BeanFactory.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/naming/factory/BeanFactory.java,v
1.1 2001/09/02 01:17:47 remm Exp $
   * $Revision: 1.1 $
   * $Date: 2001/09/02 01:17:47 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2001 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", "Tomcat", 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 apache@apache.org.
   *
   * 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/>.
   *
   * [Additional notices, if required by prior licensing conditions]
   *
   */
  
  package org.apache.naming.factory;
  
  import java.util.Hashtable;
  import java.util.Enumeration;
  import javax.naming.Name;
  import javax.naming.Context;
  import javax.naming.NamingException;
  import javax.naming.Reference;
  import javax.naming.RefAddr;
  import javax.naming.spi.ObjectFactory;
  import org.apache.naming.ResourceRef;
  
  import java.beans.Introspector;
  import java.beans.BeanInfo;
  import java.beans.PropertyDescriptor;
  
  import java.lang.reflect.Method;
  
  /**
   * Object factory for any Resource conforming to the JavaBean spec.
   * 
   * <p>This factory can be configured in a <code>&lt;DefaultContext&gt;</code>
   * or <code>&lt;Context&gt;</code> element in your <code>conf/server.xml</code>
   * configuration file.  An example of factory configuration is:</p>
   * <pre>
   * &lt;Resource name="jdbc/myDataSource" auth="SERVLET"
   *   type="oracle.jdbc.pool.OracleConnectionCacheImpl"/&gt;
   * &lt;ResourceParams name="jdbc/myDataSource"&gt;
   *   &lt;parameter&gt;
   *     &lt;name&gt;factory&lt;/name&gt;
   *     &lt;value&gt;org.apache.naming.factory.BeanFactory&lt;/value&gt;
   *   &lt;/parameter&gt;
   *   &lt;parameter&gt;
   *     &lt;name&gt;driverType&lt;/name&gt;
   *     &lt;value&gt;thin&lt;/value&gt;
   *   &lt;/parameter&gt;
   *   &lt;parameter&gt;
   *     &lt;name&gt;serverName&lt;/name&gt;
   *     &lt;value&gt;hue&lt;/value&gt;
   *   &lt;/parameter&gt;
   *   &lt;parameter&gt;
   *     &lt;name&gt;networkProtocol&lt;/name&gt;
   *     &lt;value&gt;tcp&lt;/value&gt;
   *   &lt;/parameter&gt; 
   *   &lt;parameter&gt;
   *     &lt;name&gt;databaseName&lt;/name&gt;
   *     &lt;value&gt;XXXX&lt;/value&gt;
   *   &lt;/parameter&gt;
   *   &lt;parameter&gt;
   *     &lt;name&gt;portNumber&lt;/name&gt;
   *     &lt;value&gt;NNNN&lt;/value&gt;
   *   &lt;/parameter&gt;
   *   &lt;parameter&gt;
   *     &lt;name&gt;user&lt;/name&gt;
   *     &lt;value&gt;XXXX&lt;/value&gt;
   *   &lt;/parameter&gt;
   *   &lt;parameter&gt;
   *     &lt;name&gt;password&lt;/name&gt;
   *     &lt;value&gt;XXXX&lt;/value&gt;
   *   &lt;/parameter&gt;
   *   &lt;parameter&gt;
   *     &lt;name&gt;maxLimit&lt;/name&gt;
   *     &lt;value&gt;5&lt;/value&gt;
   *   &lt;/parameter&gt;
   * &lt;/ResourceParams&gt;
   * </pre>
   *
   * @author <a href="mailto:aner at ncstech.com">Aner Perez</a>
   */
  public class BeanFactory
      implements ObjectFactory {
  
      // ----------------------------------------------------------- Constructors
  
  
      // -------------------------------------------------------------- Constants
  
  
      // ----------------------------------------------------- Instance Variables
  
  
      // --------------------------------------------------------- Public Methods
  
  
      // -------------------------------------------------- ObjectFactory Methods
  
  
      /**
       * Create a new Bean instance.
       * 
       * @param obj The reference object describing the Bean
       */
      public Object getObjectInstance(Object obj, Name name, Context nameCtx,
                                      Hashtable environment)
          throws NamingException {
  
          if (obj instanceof ResourceRef) {
  
              try {
                  
                  Reference ref = (Reference) obj;
                  String beanClassName = ref.getClassName();
                  Class beanClass = null;
                  ClassLoader tcl = 
                      Thread.currentThread().getContextClassLoader();
                  if (tcl != null) {
                      try {
                          beanClass = tcl.loadClass(beanClassName);
                      } catch(ClassNotFoundException e) {
                      }
                  } else {
                      try {
                          beanClass = Class.forName(beanClassName);
                      } catch(ClassNotFoundException e) {
                          e.printStackTrace();
                      }
                  }
                  if (beanClass == null) {
                      throw new NamingException
                          ("Class not found: " + beanClassName);
                  }
                  
                  BeanInfo bi = Introspector.getBeanInfo(beanClass);
                  PropertyDescriptor[] pda = bi.getPropertyDescriptors();
                  
                  Object bean = beanClass.newInstance();
                  
                  Enumeration e = ref.getAll();
                  while (e.hasMoreElements()) {
                      
                      RefAddr ra = (RefAddr) e.nextElement();
                      String propName = ra.getType();
                      
                      if (propName.equals(Constants.FACTORY) ||
                          propName.equals("scope") || propName.equals("auth")) {
                          continue;
                      }
                      
                      String value = (String)ra.getContent();
                      
                      Object[] valueArray = new Object[1];
                      
                      int i = 0;
                      for (i = 0; i<pda.length; i++) {
  
                          if (pda[i].getName().equals(propName)) {
  
                              Class propType = pda[i].getPropertyType();
  
                              if (propType.equals(String.class)) {
                                  valueArray[0] = value;
                              } else if (propType.equals(Character.class) 
                                         || propType.equals(char.class)) {
                                  valueArray[0] = new Character(value.charAt(0));
                              } else if (propType.equals(Byte.class) 
                                         || propType.equals(byte.class)) {
                                  valueArray[0] = new Byte(value);
                              } else if (propType.equals(Short.class) 
                                         || propType.equals(short.class)) {
                                  valueArray[0] = new Short(value);
                              } else if (propType.equals(Integer.class) 
                                         || propType.equals(int.class)) {
                                  valueArray[0] = new Integer(value);
                              } else if (propType.equals(Long.class) 
                                         || propType.equals(long.class)) {
                                  valueArray[0] = new Long(value);
                              } else if (propType.equals(Float.class) 
                                         || propType.equals(float.class)) {
                                  valueArray[0] = new Float(value);
                              } else if (propType.equals(Double.class) 
                                         || propType.equals(double.class)) {
                                  valueArray[0] = new Double(value);
                              } else {
                                  throw new NamingException
                                      ("String conversion for property type '"
                                       + propType.getName() + "' not available");
                              }
                              
                              Method setProp = pda[i].getWriteMethod();
                              if (setProp != null) {
                                  setProp.invoke(bean, valueArray);
                              } else {
                                  throw new NamingException
                                      ("Write not allowed for property: " 
                                       + propName);
                              }
  
                              break;
  
                          }
  
                      }
  
                      if (i == pda.length) {
                          throw new NamingException
                              ("No set method found for property: " + propName);
                      }
  
                  }
  
                  return bean;
  
              } catch (java.beans.IntrospectionException ie) {
                  throw new NamingException(ie.getMessage());
              } catch (java.lang.IllegalAccessException iae) {
                  throw new NamingException(iae.getMessage());
              } catch (java.lang.InstantiationException ie2) {
                  throw new NamingException(ie2.getMessage());
              } catch (java.lang.reflect.InvocationTargetException ite) {
                  throw new NamingException(ite.getMessage());
              }
  
          } else {
              return null;
          }
  
      }
  }
  
  
  

Mime
View raw message