All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.openmdx.kernel.loading.PlugInFactory Maven / Gradle / Ivy

Go to download

openMDX/Base Library

There is a newer version: 2.18.10
Show newest version
/*
 * ====================================================================
 * Project:     openMDX/Core, http://www.openmdx.org/
 * Description: Bean Factory 
 * Owner:       OMEX AG, Switzerland, http://www.omex.ch
 * ====================================================================
 *
 * This software is published under the BSD license as listed below.
 * 
 * Copyright (c) 2009-2014, OMEX AG, Switzerland
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * * 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.//        if(section == null) {
//            return new Configuration();
//        } else {
//            String name = source.getProperty(Constants.PROPERTY_NAME);
//            Configuration target = name == null ? new Configuration(
//            ) : new PropertiesConfigurationProvider(
//                Resources.toMetaInfXRI(name + ".properties"),
//                true // strict
//            ).getConfiguration(
//                section
//            );
//            amendConfiguration(
//                source,
//                target,
//                "\\.",
//                section
//            );
//            return target;
//        }

 * 
 * * Neither the name of the openMDX team nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS 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 COPYRIGHT OWNER OR 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 product includes software developed by other organizations as
 * listed in the NOTICE file.
 */
package org.openmdx.kernel.loading;

import java.lang.reflect.Constructor;
import java.lang.reflect.Modifier;
import java.util.Map;

import org.openmdx.kernel.configuration.Configuration;
import org.openmdx.kernel.configuration.MapConfiguration;
import org.w3c.spi.PrimitiveTypeParsers;

/**
 * Bean Factory
 * 

 * The following configuration entry names are reserved
    
 * 
  • class, the class to be instantiated
 * 
  • interface, the class to be exposed by the factory
 * 

 * 

 * If a class has a public Configuration constructor then 
 * this constructor is used to inject the configuration, otherwise
 * the instance is treated as java bean, i.e. it is instantiated via
 * default constructor and the configuration is applied through its
 * setters.
 */
public class PlugInFactory extends BeanFactory {

	/**
     * Constructor 
     *
     * @param instanceClass the instance class, often an interface
     * @param beanClass the Java bean class
     * @param configuration the configuration to be kept by the bean factory
     */
    private PlugInFactory(
    	Class instanceClass,	
        Class beanClass,
        Configuration configuration
    ){
    	super(instanceClass, beanClass, configuration);
        this.nonJavaBeanConstructor = getConstructorWithConfiguration(beanClass);
    }

    /**
     * Constructor 
     *
     * @param beanClass the Java Bean and instance class
     * @param settings the settings to be kept by the bean factory
     */
    private PlugInFactory(
        Class beanClass,
        Configuration configuration
    ){
    	this(beanClass, beanClass, configuration);
    }
    
    /**
     * The alternative constructor
     */
    private final Constructor nonJavaBeanConstructor;
    
    /**
     * Create a factory for the given class.
     * 

     * The class names are retrieved from the following configuration keys
    
     * 
  • "class" (mandatory)
     * 
  • "interface" (optional)
     * 

     * 
     * @param configuration the Java Bean Factory configuration includes the class name(s)
     * 
     * @return a factory for the given class
     */
    public static Factory newInstance(
		Configuration configuration
	){
    	Class instanceClass = getClass(configuration, "interface", false);
    	Class beanClass = getClass(configuration, "class", true);
		return configuration.getOptionalValue("interface", String.class) != null ? new PlugInFactory(
			instanceClass,
			beanClass,
			configuration
		) : new PlugInFactory(
			beanClass,
			configuration
		);
    }

    
    /**
     * Create a factory for the given class.
     * 

     * The bean class name is retrieved from the following configuration key
    
     * 
  • "class" (mandatory)
     * 

     * 
     * @param instanceClass the instance class
     * @param configuration the Java Bean Factory configuration
     * 
     * @return a factory for the given class
     */
    public static  Factory newInstance(
    	Class instanceClass,
		Configuration configuration
	){
        return new PlugInFactory(
		    instanceClass,
		    BeanFactory.getClass(configuration, "class", true),
		    configuration
		);
    }
    
    /**
     * Create a factory for the given Java Bean class
     * 
     * @param beanClassName
     * @param properties
     * 
     * @return a factory for the given class
     */
    public static Factory newInstance(
        String beanClassName,
        Configuration properties
    ){
        return newInstance(
        	Object.class,
        	beanClassName, 
            properties
        );
    }
    
    /**
     * Create a factory for the given Java Bean class
     * 
     * @param beanClassName
     * @param properties
     * 
     * @return a factory for the given class
     */
    public static Factory newInstance(
        String beanClassName,
        Map properties
    ){
        return newInstance(
        	Object.class,
        	beanClassName, 
            new MapConfiguration(properties, PrimitiveTypeParsers.getExtendedParser())
        );
    }

    /**
     * Create a factory for the given Java Bean class
     * 
     * @param instanceClass
     * @param beanClassName
     * @param configuration the Java Bean settings
     * 
     * @return a factory for the given class
     */
    @SuppressWarnings("unchecked")
	public static  Factory newInstance(
    	Class instanceClass,
        String beanClassName,
        Configuration configuration
    ){
        return new PlugInFactory(
		    instanceClass,
		    (Class) BeanFactory.getClass("class", beanClassName), 
		    configuration
		);
    }

    /**
     * Create a factory for the given Java Bean class
     * 
     * @param instanceClass
     * @param beanClassName
     * @param configuration the Java Bean settings
     * 
     * @return a factory for the given class
     */
    public static  Factory newInstance(
    	Class instanceClass,
        String beanClassName,
        Map configuration
    ){
    	return newInstance(
    		instanceClass, 
    		beanClassName, 
            new MapConfiguration(configuration, PrimitiveTypeParsers.getExtendedParser())
    	);
    }

    
    /* (non-Javadoc)
	 * @see org.openmdx.kernel.loading.BeanFactory#build()
	 */
	@Override
	protected T build() throws Exception {
		return this.nonJavaBeanConstructor == null ? 
			super.build(): 
			this.nonJavaBeanConstructor.newInstance(this.configuration);
	}

	/**
	 * Retrieve the (optional) alternative constructor using a 
	 * Configuration argument
	 * 
	 * @param beanClass the class to be inspected
	 * 
	 * @return the constructor unless the class is a plain java bean class
	 */
    @SuppressWarnings("unchecked")
	private Constructor getConstructorWithConfiguration(
    	Class beanClass	
    ){
    	for(Constructor constructor: beanClass.getConstructors()){
    		if(isPublic(constructor)) {
	    		final Class[] parameterTypes = constructor.getParameterTypes();
	    		if(parameterTypes.length == 1) {
	    			if(parameterTypes[0] == Configuration.class) {
	    				return (Constructor) constructor;
	    			}
	    		}
    		}
    	}
    	return null;
    }
    
    /**
     * Tests whether the constructor is public
     * 
     * @param constructor the constructor to be tested
     * 
     * @return true if he constructor is public
     */
    private static boolean isPublic(
    	Constructor constructor
    ){
    	return (constructor.getModifiers() & Modifier.PUBLIC) != 0;
    }

}    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy