org.ikasan.configurationService.service.ConfigurationFactoryDefaultImpl Maven / Gradle / Ivy

Go to download
/* 
 * $Id$
 * $URL$
 *
 * ====================================================================
 * Ikasan Enterprise Integration Platform
 * 
 * Distributed under the Modified BSD License.
 * Copyright notice: The copyright for this software and a full listing 
 * of individual contributors are as shown in the packaged copyright.txt 
 * file. 
 * 
 * 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.
 *
 *  - Neither the name of the ORGANIZATION 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 HOLDER 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.
 * ====================================================================
 */
package org.ikasan.configurationService.service;

import org.ikasan.configurationService.model.*;
import org.ikasan.configurationService.util.ReflectionUtils;
import org.ikasan.spec.configuration.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

/**
 * Default implementation of the ConfigurationFactory for creating configuration
 * and configuration parameter instances.
 *
 * @author Ikasan Development Team
 */
public class ConfigurationFactoryDefaultImpl implements ConfigurationFactory {

    private static Logger logger = LoggerFactory.getLogger(ConfigurationFactoryDefaultImpl.class);

    private static ConfigurationFactory configurationFactory = new ConfigurationFactoryDefaultImpl();

    /**
     * Get an instance of the configurationFactory. This is a thread-safe
     * singleton.
     *
     * @return
     */
    public static ConfigurationFactory getInstance() {
        return configurationFactory;
    }

    private ConfigurationFactoryDefaultImpl() {
        // hide the constructor
    }

    public Configuration> createConfiguration(
            String configurationResourceId) {
        return new DefaultConfiguration(configurationResourceId,
                new ArrayList());
    }

    /**
     * Create a filtered configuration given an Id and a representation of the current runtime configuration
     *
     * @param configurationResourceId - The id for the configuration resource
     * @param runtimeConfiguration - The runtime configuration
     * @return
     */
    public Configuration> createConfiguration(String configurationResourceId, Object runtimeConfiguration) {
        if (runtimeConfiguration == null) {
            throw new ConfigurationException("Runtime configuration object cannot be 'null'");
        }

        Configuration> configuration = new DefaultConfiguration(configurationResourceId, new ArrayList());

        Map properties = ReflectionUtils.getPropertiesIgnoringExceptions(runtimeConfiguration);
        // We wrap this in a TreeMap because PropertyUtils does not offer ordering (as of version 1.9.1) and several
        // tests require implicit ordering (and it's not a bad thing to have ordering anyhow)
        TreeMap orderedProperties = new TreeMap<>(properties);

        for (Map.Entry entry : orderedProperties.entrySet())
        {
            String name = entry.getKey();
            Object value = entry.getValue();

            try
            {
                if (value == null) {
                    Class cls = ReflectionUtils.getPropertyType(runtimeConfiguration, name);

                    if (cls.isAssignableFrom(String.class)) {
                        if (isMasked(runtimeConfiguration, name)) {
                            configuration.getParameters().add(new ConfigurationParameterMaskedStringImpl(name, null));
                        } else {
                            configuration.getParameters().add(new ConfigurationParameterStringImpl(name, null));
                        }
                    } else if (cls.isAssignableFrom(Long.class)) {
                        configuration.getParameters().add(new ConfigurationParameterLongImpl(name, null));
                    } else if (cls.isAssignableFrom(Integer.class)) {
                        configuration.getParameters().add(new ConfigurationParameterIntegerImpl(name, null));
                    } else if (cls.isAssignableFrom(Boolean.class)) {
                        configuration.getParameters().add(new ConfigurationParameterBooleanImpl(name, null));
                    } else if (cls.isAssignableFrom(List.class)) {
                        configuration.getParameters().add(new ConfigurationParameterListImpl(name, null));
                    } else if (cls.isAssignableFrom(Map.class)) {
                        configuration.getParameters().add(new ConfigurationParameterMapImpl(name, null));
                    } else {
                        logger.warn("Ignoring unsupported configurationParameter class [" + cls.getName() + "].");
                    }
                } else {
                    if (value instanceof String) {
                        if (isMasked(runtimeConfiguration, name)) {
                            configuration.getParameters().add(new ConfigurationParameterMaskedStringImpl(name, (String) value));
                        } else {
                            configuration.getParameters().add(new ConfigurationParameterStringImpl(name, (String) value));
                        }
                    } else if (value instanceof Long) {
                        configuration.getParameters().add(new ConfigurationParameterLongImpl(name, (Long) value));
                    } else if (value instanceof Integer) {
                        configuration.getParameters().add(new ConfigurationParameterIntegerImpl(name, (Integer) value));
                    } else if (value instanceof Boolean) {
                        configuration.getParameters().add(new ConfigurationParameterBooleanImpl(name, (Boolean) value));
                    } else if (value instanceof List) {
                        configuration.getParameters().add(new ConfigurationParameterListImpl(name, (List) value));
                    } else if (value instanceof Map) {
                        configuration.getParameters().add(new ConfigurationParameterMapImpl(name, (Map) value));
                    } else {
                        logger.warn("Ignoring unsupported configurationParameter class [" + value.getClass().getName() + "].");
                    }
                }
            }
            catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException | NoSuchFieldException e)
            {
                logger.error("Failed to get property type for field [" + name + "].");
            }
        }

        return configuration;
    }

    /**
     * Is this runtime configuration name data item subject to being masked
     *
     * @param runtimeConfiguration
     * @param name
     * @return
     * @throws ConfigurationException
     */
    protected boolean isMasked(Object runtimeConfiguration, String name)
            throws ConfigurationException {
        try {
            Field field = getField(runtimeConfiguration.getClass(), name);

            if (field.isAnnotationPresent(Masked.class)) {
                return true;
            }

        } catch (NoSuchFieldException e) {
            logger.warn("Unable to ascertain is field [" + name
                    + "] is annotated for masking.", e);
        }

        return false;
    }

    /**
     * Helper method to attempt to get the field from the class hierarchy.
     *
     * @param clazz
     * @param fieldName
     * @return
     * @throws NoSuchFieldException
     */
    public Field getField(Class clazz, String fieldName) throws NoSuchFieldException {
        try {
            return clazz.getDeclaredField(fieldName);
        } catch (NoSuchFieldException e) {
            Class superClass = clazz.getSuperclass();
            if (superClass == null) {
                throw e;
            } else {
                return getField(superClass, fieldName);
            }
        }
    }
}