All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • io.helidon.config.mp.MpConfigImpl Maven / Gradle / Ivy

    There is a newer version: 4.1.4
    Show newest version
    /*
 * Copyright (c) 2020, 2023 Oracle and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.helidon.config.mp;

import java.lang.System.Logger.Level;
import java.lang.reflect.Array;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Optional;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import io.helidon.config.mp.spi.MpConfigFilter;

import org.eclipse.microprofile.config.Config;
import org.eclipse.microprofile.config.ConfigValue;
import org.eclipse.microprofile.config.spi.ConfigSource;
import org.eclipse.microprofile.config.spi.Converter;

/**
 * Implementation of the basic MicroProfile {@link org.eclipse.microprofile.config.Config} API.
 */
class MpConfigImpl implements Config {
    private static final System.Logger LOGGER = System.getLogger(MpConfigImpl.class.getName());
    // for references resolving
    // matches string between ${ } with a negative lookbehind if there is not backslash
    private static final String REGEX_REFERENCE = "(?> UNRESOLVED_KEYS = ThreadLocal.withInitial(HashSet::new);

    private static final Pattern SPLIT_PATTERN = Pattern.compile("(?, Class> REPLACED_TYPES = new HashMap<>();

    static {
        REPLACED_TYPES.put(Byte.TYPE, Byte.class);
        REPLACED_TYPES.put(Short.TYPE, Short.class);
        REPLACED_TYPES.put(Integer.TYPE, Integer.class);
        REPLACED_TYPES.put(Long.TYPE, Long.class);
        REPLACED_TYPES.put(Float.TYPE, Float.class);
        REPLACED_TYPES.put(Double.TYPE, Double.class);
        REPLACED_TYPES.put(Boolean.TYPE, Boolean.class);
        REPLACED_TYPES.put(Character.TYPE, Character.class);
    }

    private final List sources = new LinkedList<>();
    private final HashMap, Converter> converters = new LinkedHashMap<>();
    private final boolean valueResolving;
    private final List filters = new ArrayList<>();
    private final String configProfile;

    MpConfigImpl(List sources,
                 HashMap, Converter> converters,
                 List filters,
                 String profile) {
        this.sources.addAll(sources);
        this.converters.putAll(converters);
        this.converters.putIfAbsent(String.class, value -> value);
        this.configProfile = profile;

        this.valueResolving = getOptionalValue("mp.config.property.expressions.enabled", Boolean.class)
                .or(() -> getOptionalValue("helidon.config.value-resolving.enabled", Boolean.class))
                .orElse(true);

        // we need to initialize the filters first, before we set up filters
        filters.forEach(it -> {
            // initialize filter with filters with higher priority already in place
            it.init(this);
            // and then add it to the list of active filters
            // do not do this first, as we would end up in using an uninitialized filter
            this.filters.add(it);
        });
    }

    @Override
    public ConfigValue getConfigValue(String key) {
        if (configProfile == null) {
            return findConfigValue(key)
                    .orElseGet(() -> new ConfigValueImpl(key, null, null, null, 0));
        }
        return findConfigValue("%" + configProfile + "." + key)
                .or(() -> findConfigValue(key))
                .orElseGet(() -> new ConfigValueImpl(key, null, null, null, 0));
    }

    @Override
    public  T getValue(String propertyName, Class propertyType) {
        return getOptionalValue(propertyName, propertyType)
                .orElseThrow(() -> new NoSuchElementException("Property \"" + propertyName + "\" is not available in "
                                                                      + "configuration"));
    }

    @SuppressWarnings("unchecked")
    @Override
    public  Optional getOptionalValue(String propertyName, Class propertyType) {
        if (configProfile == null) {
            return optionalValue(propertyName, propertyType);
        }

        return optionalValue("%" + configProfile + "." + propertyName, propertyType)
                .or(() -> optionalValue(propertyName, propertyType));
    }

    @SuppressWarnings("unchecked")
    private  Optional optionalValue(String propertyName, Class propertyType) {
        // let's resolve arrays
        if (propertyType.isArray()) {
            Class componentType = propertyType.getComponentType();
            // first try to see if we have a direct value
            Optional optionalValue = getOptionalValue(propertyName, String.class);
            if (optionalValue.isPresent()) {
                try {
                    return Optional.of((T) toArray(propertyName, optionalValue.get(), componentType));
                } catch (NoSuchElementException e) {
                    return Optional.empty();
                }
            }

            /*
             we also support indexed value
             e.g. for key "my.list" you can have both:
             my.list=12,13,14
             or (not and):
             my.list.0=12
             my.list.1=13
             */

            String indexedConfigKey = propertyName + ".0";
            optionalValue = getOptionalValue(indexedConfigKey, String.class);
            if (optionalValue.isPresent()) {
                List result = new LinkedList<>();

                // first element is already in
                result.add(convert(indexedConfigKey, componentType, optionalValue.get()));

                // hardcoded limit to lists of 1000 elements
                for (int i = 1; i < 1000; i++) {
                    indexedConfigKey = propertyName + "." + i;
                    optionalValue = getOptionalValue(indexedConfigKey, String.class);
                    if (optionalValue.isPresent()) {
                        result.add(convert(indexedConfigKey, componentType, optionalValue.get()));
                    } else {
                        // finish the iteration on first missing index
                        break;
                    }
                }
                Object array = Array.newInstance(componentType, result.size());
                for (int i = 0; i < result.size(); i++) {
                    Object component = result.get(i);
                    Array.set(array, i, component);
                }
                return Optional.of((T) array);
            } else {
                return Optional.empty();
            }
        } else {
            return findConfigValue(propertyName)
                    .map(ConfigValue::getValue)
                    .map(it -> convert(propertyName, propertyType, it));
        }
    }

    @Override
    public Iterable getPropertyNames() {
        Set names = new LinkedHashSet<>();
        for (ConfigSource source : sources) {
            names.addAll(source.getPropertyNames());
        }
        return names;
    }

    @Override
    public Iterable getConfigSources() {
        return Collections.unmodifiableList(sources);
    }

    /**
     * Unwrap into an implementation.
     * This method will be added in MP Config 2.0.
     *
     * @param aClass class to unwrap to (only this class and {@link org.eclipse.microprofile.config.Config} are supported)
     * @param  type of the class
     * @return typed instance
     */
    @Override
    public  T unwrap(Class aClass) {
        if (getClass().equals(aClass)) {
            return aClass.cast(this);
        }
        if (aClass.equals(Config.class)) {
            return aClass.cast(this);
        }
        throw new UnsupportedOperationException("Cannot unwrap config into " + aClass.getName());
    }

    /**
     * Return the {@link Converter} used by this instance to produce instances of the specified type from string values.
     *
     * This method is from a future version of MP Config specification and may changed before it
     * is released. It is nevertheless needed to process annotations with default values.
     *
     * @param  the conversion type
     * @param forType the type to be produced by the converter
     * @return an {@link java.util.Optional} containing the converter, or empty if no converter is available for the specified type
     */
    @SuppressWarnings("unchecked")
    @Override
    public  Optional> getConverter(Class forType) {
        if (forType.isArray()) {
            Class componentType = forType.getComponentType();
            return findComponentConverter(componentType)
                    .map(it -> toArrayConverter(forType, componentType, it));

        } else {
            return findComponentConverter(forType);
        }
    }

    @SuppressWarnings("unchecked")
    private  Optional> findComponentConverter(Class type) {
        Class forType = mapType(type);

        return converters.entrySet()
                .stream()
                .filter(it -> forType.isAssignableFrom(it.getKey()))
                .findFirst()
                .map(Map.Entry::getValue)
                .map(it -> (Converter) it)
                .or(() -> findImplicit(forType));
    }

    // map from primitive to object types
    @SuppressWarnings("unchecked")
    private  Class mapType(Class original) {
        Class aClass = (Class) REPLACED_TYPES.get(original);

        return (aClass == null) ? original : aClass;
    }

    private  Converter toArrayConverter(Class type, Class componentType, Converter elementConverter) {
        return configValue -> {
            if (configValue == null) {
                throw new NullPointerException("Null not allowed in MP converters. Converter for type " + type.getName());
            }
            String[] values = toArray(configValue);

            Object array = Array.newInstance(componentType, values.length);

            for (int i = 0; i < values.length; i++) {
                String value = values[i];
                Array.set(array, i, elementConverter.convert(value));
            }

            return type.cast(array);
        };
    }
    /**
     * Convert a String to a specific type.
     * This is a helper method to allow for processing of default values that cannot be typed (e.g. in annotations).
     *
     * @param propertyName name of the property, used for error messages
     * @param type  type of the property
     * @param value String value (may be null)
     * @param    type
     * @return instance of the correct type, may return null in case null was provided and converter did not do this
     * @throws IllegalArgumentException in case the String provided cannot be converted to the type expected
     */
    private  T convert(String propertyName, Class type, String value) {
        try {
            return obtainConverter(type)
                    .convert(value);
        } catch (Exception e) {
            throw new IllegalArgumentException("Failed to convert property \""
                                                       + propertyName
                                                       + "\" from its value \""
                                                       + value
                                                       + "\" to "
                                                       + type.getName(),
                                               e);
        }
    }

    private Optional findConfigValue(String propertyName) {
        for (ConfigSource source : sources) {
            String value = source.getValue(propertyName);

            if (null == value) {
                // not in this one
                continue;
            }

            if (value.isEmpty()) {
                if (LOGGER.isLoggable(Level.TRACE)) {
                    LOGGER.log(Level.TRACE, "Found property " + propertyName
                                          + " in source " + source.getName()
                                          + " and it is empty (removed)");
                }
                return Optional.empty();
            }

            if (LOGGER.isLoggable(Level.TRACE)) {
                LOGGER.log(Level.TRACE, "Found property " + propertyName + " in source " + source.getName());
            }
            String rawValue = value;
            try {
                return applyFilters(propertyName, value)
                        .map(it -> resolveReferences(propertyName, it))
                        .map(it -> new ConfigValueImpl(propertyName, it, rawValue, source.getName(), source.getOrdinal()));
            } catch (NoSuchElementException e) {
                // Property expression does not resolve
                return Optional.empty();
            }
        }

        return Optional.empty();
    }

    private Optional applyFilters(String propertyName, String stringValue) {
        String result = stringValue;

        for (MpConfigFilter filter : filters) {
            result = filter.apply(propertyName, result);
        }

        return Optional.ofNullable(result);
    }

    private Object toArray(String propertyName, String stringValue, Class componentType) {
        String[] values = toArray(stringValue);

        Object array = Array.newInstance(componentType, values.length);

        for (int i = 0; i < values.length; i++) {
            String value = values[i];
            Array.set(array, i, convert(propertyName, componentType, value));
        }

        return array;
    }

    private String resolveReferences(String key, String value) {
        if (!valueResolving) {
            return value;
        }
        if (!UNRESOLVED_KEYS.get().add(key)) {
            UNRESOLVED_KEYS.get().clear();
            throw new IllegalArgumentException("Recursive resolving of references for key " + key + ", value: " + value);
        }
        try {
            return value.contains("${") ? processExpressions(value) : value;
        } finally {
            UNRESOLVED_KEYS.get().remove(key);
        }
    }

    private String processExpressions(String value) {
        if (value.equals("${EMPTY}")) {
            return "";
        }

        int iteration = 0;
        String current;
        String replaced = value;
        do {
            if (iteration > 4) {
                throw new IllegalArgumentException("Too many iterations on property expression. Original value: " + value + ", "
                                                           + "currentValue: " + replaced);
            }
            current = replaced;
            replaced = format(current);
            iteration++;

        } while (!replaced.equals(current));

        // remove all backslash that encodes ${...}
        Matcher m = PATTERN_BACKSLASH.matcher(replaced);
        return m.replaceAll("");
    }

    private String format(String value) {
        Matcher m = PATTERN_REFERENCE.matcher(value);
        final StringBuffer sb = new StringBuffer();
        while (m.find()) {
            String propertyName = m.group(1);
            Optional propertyValue = getOptionalValue(propertyName, String.class);
            String defaultValue = m.group(2);
            String finalValue;
            if (defaultValue == null) {
                //the specification requires us to fail if property not found
                //finalValue = propertyValue.orElseGet(() -> "${" + propertyName + "}");
                finalValue = propertyValue
                        .orElseThrow(() -> new NoSuchElementException("Property "
                                                                              + propertyName
                                                                              + " used in expression "
                                                                              + value
                                                                              + " does not exist"));
            } else {
                // the capturing group captures the : separator, so let's only use the value after it
                finalValue = propertyValue.orElse(defaultValue.substring(1));
            }
            m.appendReplacement(sb,
                                Matcher.quoteReplacement(finalValue));
        }
        m.appendTail(sb);

        return sb.toString();
    }

    @SuppressWarnings("unchecked")
     Converter obtainConverter(Class type) {
        return getConverter(type)
                .orElseGet(() -> new FailingConverter<>(type));
    }

    @SuppressWarnings("unchecked")
    private  Optional> findImplicit(Class type) {
        // enums must be explicitly supported
        if (Enum.class.isAssignableFrom(type)) {
            return Optional.of(value -> {
                Class enumClass = (Class) type;
                return (T) Enum.valueOf(enumClass, value);
            });
        }
        // any class that has a "public static T method()"
        Optional method = findMethod(type, "of", String.class)
                .or(() -> findMethod(type, "valueOf", String.class))
                .or(() -> findMethod(type, "parse", CharSequence.class))
                .or(() -> findMethod(type, "parse", String.class));

        if (method.isPresent()) {
            Method m = method.get();
            return Optional.of(value -> {
                try {
                    return (T) m.invoke(null, value);
                } catch (Exception e) {
                    throw new IllegalArgumentException("Failed to convert to " + type.getName() + " using a static method", e);
                }
            });
        }

        // constructor with a single string parameter
        try {
            Constructor constructor = type.getConstructor(String.class);
            if (constructor.canAccess(null)) {
                return Optional.of(value -> {
                    try {
                        return constructor.newInstance(value);
                    } catch (Exception e) {
                        throw new IllegalArgumentException("Failed to convert to " + type.getName() + " using a constructor", e);
                    }
                });
            } else {
                LOGGER.log(Level.TRACE, "Constructor with String parameter is not accessible on type " + type);
            }
        } catch (NoSuchMethodException e) {
            LOGGER.log(Level.TRACE, "There is no public constructor with string parameter on class " + type.getName(), e);
        }

        return Optional.empty();
    }

    private Optional findMethod(Class type, String name, Class... parameterTypes) {
        try {
            Method result = type.getDeclaredMethod(name, parameterTypes);
            if (!result.canAccess(null)) {
                LOGGER.log(Level.TRACE, () -> "Method " + name + "(" + Arrays
                        .toString(parameterTypes) + ") is not accessible on class " + type.getName());
                return Optional.empty();
            }
            if (!Modifier.isStatic(result.getModifiers())) {
                LOGGER.log(Level.TRACE, () -> "Method " + name + "(" + Arrays
                        .toString(parameterTypes) + ") is not static on class " + type.getName());
                return Optional.empty();
            }

            return Optional.of(result);
        } catch (NoSuchMethodException e) {
            LOGGER.log(Level.TRACE,
                       "Method " + name + "(" + Arrays.toString(parameterTypes) + ") is not avilable on class " + type.getName(),
                       e);
            return Optional.empty();
        }
    }

    HashMap, Converter> converters() {
        return converters;
    }

    static String[] toArray(String stringValue) {
        String[] values = SPLIT_PATTERN.split(stringValue, -1);

        List result = new ArrayList<>(values.length);

        for (String s : values) {
            String value = ESCAPED_COMMA_PATTERN.matcher(s).replaceAll(Matcher.quoteReplacement(","));
            if (!value.isEmpty()) {
                result.add(value);
            }
        }

        if (result.isEmpty()) {
            throw new NoSuchElementException("Value " + stringValue + " resolved into an empty array");
        }

        return result.toArray(new String[0]);
    }

    private static class FailingConverter implements Converter {
        private final Class type;

        private FailingConverter(Class type) {
            this.type = type;
        }

        @Override
        public T convert(String value) {
            throw new IllegalArgumentException("Cannot convert \"" + value + "\" to type " + type.getName());
        }
    }
}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy